Renovate README with more detailed instructions

Author: Scriptim

README.md

@@ -1,36 +1,118 @@
-<h1 align="center">Bash Prompt Generator</h1>
+# Bash Prompt Generator
 
-<p align="center">
-  <a href="./LICENSE" title="License">
-    <img src="https://img.shields.io/github/license/Scriptim/bash-prompt-generator">
-  </a>
-  <a href="https://github.com/Scriptim/bash-prompt-generator/stargazers" title="GitHub Stars">
-    <img src="https://img.shields.io/github/stars/Scriptim/bash-prompt-generator?style=social">
-  </a>
-  <a href="https://github.com/Scriptim/bash-prompt-generator/fork" title="Fork GitHub Repo">
-    <img src="https://img.shields.io/github/forks/Scriptim/bash-prompt-generator?style=social">
-  </a>
-  <br><br>
-  <b>Create a custom PS1 variable for your Bash.</b>
-  <br><br>
-  <a align="center" href="https://scriptim.github.io/bash-prompt-generator" title="Check It Out">
-    <img src="https://forthebadge.com/images/badges/check-it-out.svg">
-  </a>
-</p>
+**Create a custom PS1 variable for your Bash.**
 
-## Example
+[![github-stars](https://img.shields.io/github/stars/Scriptim/bash-prompt-generator?style=social)](https://github.com/Scriptim/bash-prompt-generator/stargazers "Stargazers")
+&emsp;
+[![github-forks](https://img.shields.io/github/forks/Scriptim/bash-prompt-generator?style=social)](https://github.com/Scriptim/bash-prompt-generator/fork "Forks")
 
-![Browser (Screenshot)](./img/screenshot_browser.png)
 
-### Result
+<!-- badge generated using https://forthebadge.com/generator/ -->
+[![generate-your-prompt](data:image/svg+xml;base64,<svg xmlns="http://www.w3.org/2000/svg" width="262.14" height="35" viewBox="0 0 262.14 35"><rect class="svg__rect" x="0" y="0" width="107.06" height="35" fill="#415658"/><rect class="svg__rect" x="105.06" y="0" width="157.07999999999998" height="35" fill="#00ADB5"/><path class="svg__text" d="M13.97 18.13L13.97 18.13L13.97 17.46Q13.97 15.53 14.90 14.44Q15.82 13.35 17.48 13.35L17.48 13.35Q18.90 13.35 19.74 14.05Q20.58 14.76 20.75 16.08L20.75 16.08L19.30 16.08Q19.05 14.54 17.51 14.54L17.51 14.54Q16.51 14.54 16.00 15.26Q15.48 15.98 15.46 17.37L15.46 17.37L15.46 18.02Q15.46 19.40 16.04 20.17Q16.63 20.93 17.66 20.93L17.66 20.93Q18.80 20.93 19.28 20.42L19.28 20.42L19.28 18.75L17.52 18.75L17.52 17.62L20.76 17.62L20.76 20.89Q20.29 21.50 19.47 21.81Q18.65 22.12 17.61 22.12L17.61 22.12Q16.54 22.12 15.71 21.63Q14.89 21.14 14.44 20.24Q13.99 19.33 13.97 18.13ZM30.95 22L25.37 22L25.37 13.47L30.91 13.47L30.91 14.66L26.86 14.66L26.86 17.02L30.36 17.02L30.36 18.19L26.86 18.19L26.86 20.82L30.95 20.82L30.95 22ZM36.63 22L35.15 22L35.15 13.47L36.63 13.47L40.44 19.54L40.44 13.47L41.91 13.47L41.91 22L40.43 22L36.63 15.95L36.63 22ZM52.23 22L46.65 22L46.65 13.47L52.19 13.47L52.19 14.66L48.14 14.66L48.14 17.02L51.64 17.02L51.64 18.19L48.14 18.19L48.14 20.82L52.23 20.82L52.23 22ZM57.91 22L56.43 22L56.43 13.47L59.43 13.47Q60.90 13.47 61.71 14.13Q62.51 14.79 62.51 16.05L62.51 16.05Q62.51 16.90 62.10 17.48Q61.68 18.06 60.95 18.37L60.95 18.37L62.86 21.92L62.86 22L61.27 22L59.56 18.71L57.91 18.71L57.91 22ZM57.91 14.66L57.91 17.52L59.43 17.52Q60.18 17.52 60.61 17.15Q61.03 16.77 61.03 16.11L61.03 16.11Q61.03 15.43 60.64 15.05Q60.25 14.68 59.48 14.66L59.48 14.66L57.91 14.66ZM67.68 22L66.14 22L69.37 13.47L70.70 13.47L73.92 22L72.38 22L71.68 20.01L68.38 20.01L67.68 22ZM70.03 15.28L68.79 18.82L71.26 18.82L70.03 15.28ZM79.56 14.66L76.92 14.66L76.92 13.47L83.69 13.47L83.69 14.66L81.03 14.66L81.03 22L79.56 22L79.56 14.66ZM93.03 22L87.45 22L87.45 13.47L92.98 13.47L92.98 14.66L88.93 14.66L88.93 17.02L92.43 17.02L92.43 18.19L88.93 18.19L88.93 20.82L93.03 20.82L93.03 22Z" fill="#FFFFFF"/><path class="svg__text" d="M121.37 18.95L118.17 13.60L120.68 13.60L122.67 16.94L124.66 13.60L126.96 13.60L123.75 18.99L123.75 22L121.37 22L121.37 18.95ZM130.62 17.80L130.62 17.80Q130.62 16.55 131.22 15.55Q131.83 14.56 132.89 14.00Q133.95 13.43 135.28 13.43L135.28 13.43Q136.62 13.43 137.68 14.00Q138.74 14.56 139.35 15.55Q139.95 16.55 139.95 17.80L139.95 17.80Q139.95 19.05 139.35 20.04Q138.74 21.04 137.68 21.60Q136.62 22.17 135.28 22.17L135.28 22.17Q133.95 22.17 132.89 21.60Q131.83 21.04 131.22 20.04Q130.62 19.05 130.62 17.80ZM133.02 17.80L133.02 17.80Q133.02 18.51 133.32 19.05Q133.62 19.60 134.14 19.90Q134.65 20.20 135.28 20.20L135.28 20.20Q135.92 20.20 136.44 19.90Q136.95 19.60 137.25 19.05Q137.55 18.51 137.55 17.80L137.55 17.80Q137.55 17.09 137.25 16.54Q136.95 16 136.44 15.70Q135.92 15.40 135.28 15.40L135.28 15.40Q134.65 15.40 134.13 15.70Q133.62 16 133.32 16.54Q133.02 17.09 133.02 17.80ZM144.61 18.26L144.61 18.26L144.61 13.60L146.99 13.60L146.99 18.19Q146.99 20.20 148.59 20.20L148.59 20.20Q150.17 20.20 150.17 18.19L150.17 18.19L150.17 13.60L152.51 13.60L152.51 18.26Q152.51 20.13 151.47 21.15Q150.43 22.17 148.56 22.17L148.56 22.17Q146.69 22.17 145.65 21.15Q144.61 20.13 144.61 18.26ZM159.98 22L157.60 22L157.60 13.60L161.44 13.60Q162.58 13.60 163.42 13.98Q164.26 14.35 164.72 15.06Q165.17 15.76 165.17 16.71L165.17 16.71Q165.17 17.62 164.75 18.30Q164.32 18.98 163.53 19.36L163.53 19.36L165.34 22L162.79 22L161.27 19.77L159.98 19.77L159.98 22ZM159.98 15.47L159.98 17.93L161.29 17.93Q162.03 17.93 162.40 17.61Q162.77 17.29 162.77 16.71L162.77 16.71Q162.77 16.12 162.40 15.79Q162.03 15.47 161.29 15.47L161.29 15.47L159.98 15.47ZM179.31 22L176.93 22L176.93 13.60L180.78 13.60Q181.91 13.60 182.75 13.98Q183.60 14.35 184.05 15.06Q184.51 15.76 184.51 16.71L184.51 16.71Q184.51 17.66 184.05 18.35Q183.60 19.05 182.75 19.42Q181.91 19.80 180.78 19.80L180.78 19.80L179.31 19.80L179.31 22ZM179.31 15.47L179.31 17.93L180.63 17.93Q181.36 17.93 181.74 17.61Q182.11 17.29 182.11 16.71L182.11 16.71Q182.11 16.12 181.74 15.80Q181.36 15.47 180.63 15.47L180.63 15.47L179.31 15.47ZM191.64 22L189.26 22L189.26 13.60L193.11 13.60Q194.25 13.60 195.09 13.98Q195.92 14.35 196.38 15.06Q196.84 15.76 196.84 16.71L196.84 16.71Q196.84 17.62 196.41 18.30Q195.98 18.98 195.19 19.36L195.19 19.36L197.00 22L194.46 22L192.94 19.77L191.64 19.77L191.64 22ZM191.64 15.47L191.64 17.93L192.96 17.93Q193.69 17.93 194.06 17.61Q194.44 17.29 194.44 16.71L194.44 16.71Q194.44 16.12 194.06 15.79Q193.69 15.47 192.96 15.47L192.96 15.47L191.64 15.47ZM201.20 17.80L201.20 17.80Q201.20 16.55 201.80 15.55Q202.40 14.56 203.47 14.00Q204.53 13.43 205.86 13.43L205.86 13.43Q207.19 13.43 208.25 14.00Q209.32 14.56 209.92 15.55Q210.53 16.55 210.53 17.80L210.53 17.80Q210.53 19.05 209.92 20.04Q209.32 21.04 208.26 21.60Q207.20 22.17 205.86 22.17L205.86 22.17Q204.53 22.17 203.47 21.60Q202.40 21.04 201.80 20.04Q201.20 19.05 201.20 17.80ZM203.59 17.80L203.59 17.80Q203.59 18.51 203.90 19.05Q204.20 19.60 204.71 19.90Q205.23 20.20 205.86 20.20L205.86 20.20Q206.50 20.20 207.02 19.90Q207.53 19.60 207.83 19.05Q208.13 18.51 208.13 17.80L208.13 17.80Q208.13 17.09 207.83 16.54Q207.53 16 207.02 15.70Q206.50 15.40 205.86 15.40L205.86 15.40Q205.22 15.40 204.71 15.70Q204.20 16 203.90 16.54Q203.59 17.09 203.59 17.80ZM217.46 22L215.26 22L215.26 13.60L217.22 13.60L220.17 18.45L223.05 13.60L225.00 13.60L225.03 22L222.85 22L222.82 17.55L220.66 21.17L219.61 21.17L217.46 17.67L217.46 22ZM232.57 22L230.19 22L230.19 13.60L234.03 13.60Q235.17 13.60 236.01 13.98Q236.85 14.35 237.31 15.06Q237.77 15.76 237.77 16.71L237.77 16.71Q237.77 17.66 237.31 18.35Q236.85 19.05 236.01 19.42Q235.17 19.80 234.03 19.80L234.03 19.80L232.57 19.80L232.57 22ZM232.57 15.47L232.57 17.93L233.89 17.93Q234.62 17.93 234.99 17.61Q235.36 17.29 235.36 16.71L235.36 16.71Q235.36 16.12 234.99 15.80Q234.62 15.47 233.89 15.47L233.89 15.47L232.57 15.47ZM244.31 15.48L241.73 15.48L241.73 13.60L249.25 13.60L249.25 15.48L246.68 15.48L246.68 22L244.31 22L244.31 15.48Z" fill="#FFFFFF" x="118.06"/></svg>)](https://bash-prompt-generator.org "Check it out")
 
-![Terminal (Screenshot)](./img/screenshot_terminal.png)
+## What is a Bash  Prompt?
 
-## See also
+The prompt is a short piece of text that is displayed in the Bash shell prompting you to enter a command.
+
+![Bash Prompt Example](./docs/bash_prompt_example.png)
+
+It usually contains some useful information about the current user, the working directory, etc.
+
+## Where is the Prompt Configured?
+
+The `PS1` environment variable determines what information the prompt contains and how it is displayed.
+
+![Echo $PS1](./docs/bash_echo_ps1.png)
+
+The default value may vary between different distributions and versions.
+
+Setting the `PS1` variable yourself (e.&nbsp;g. by appending the line `PS1='[\u@\h \w]\$ '` to your `~/.bashrc` file) allows you to customize your prompt.
+
+## How is the Prompt Configured?
+
+The syntax of the `PS1` variable allows versatile customization options.
+In addition to the information displayed, colors as well as other display attributes can be adjusted.
+
+However, this syntax is difficult to read by humans and manual customization is therefore extremely tedious.
+
+For this reason, this project provides a way to create a prompt via a GUI without having to modify the PS1 variable itself.
+
+### See also
 
 - [GNU Bash Manual: Controlling the Prompt](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html)
 - [ArchWiki: Bash/Prompt customization](https://wiki.archlinux.org/index.php/Bash/Prompt_customization)
 
+## How to Use
+
+### Getting Started
+
+When you visit the [website](https://bash-prompt-generator.org) for the first time, you have the option to either create a new prompt from scratch or import your current prompt for adjustment.
+
+![Website First View](./docs/bash_prompt_generator_initial.png)
+
+A prompt consists of multiple so-called *elements*.
+You can click on one of the elements on the left (*Prompt Elements*) to add it to your prompt.
+If you choose to import your existing prompt, paste the output of `echo $PS1` (e.&nbsp;g. `[\u@\h \w]\$ `) into the text field and the according elements will be automatically added to your prompt.
+
+### Your Prompt
+
+The *Your Prompt* sections lists all elements that are currently part of your prompt.
+
+![Your Prompt](./docs/bash_prompt_generator_your_prompt.png)
+
+You can always add more elements from the *Prompt Elements* section on the left, reorder the elements in your prompt using drag and drop or remove them.
+
+The trash icon will remove all elements from your prompt, letting you start from scratch.
+
+The command for setting the `PS1` variable is displayed in the *Output* section, along with an example preview of how your prompt might look like.
+
+![Output](./docs/bash_prompt_generator_output.png)
+
+The clipboard icon will copy the full command to your clipboard.
+
+If you run the generated command in your terminal, you will immediately see the changes to your prompt.
+These changes will be lost when you close your terminal, however.
+In order to make the changes permanent, you have to add the command to your `~/.bashrc` file.
+
+Note that the preview will most likely differ from the actual prompt in your terminal because the environment (such as the current user, hostname, etc.) is different.
+
+You can click on the lightbulb icon to toggle between a dark and a light background for the preview.
+
+### Properties
+
+All elements can be selected by clicking on them.
+
+![Selected](./docs/bash_prompt_generator_selected.png)
+
+Depending on the type of the selected element, different properties can be adjusted.
+
+![Properties](./docs/bash_prompt_generator_properties.png)
+
+Most elements support colors and various display attributes.
+
+Look at the example preview to see how these properties affect the prompt.
+
+Foreground and background colors can be choosen via a color picker.
+
+![Color Picker](./docs/bash_prompt_generator_colors.png)
+
+The color picker provides a *no color* option for resetting to the default color, 16 4-bit colors (top row) and 256 8-bit colors (bottom rows).
+
+Note that some terminals may not support all colors.
+The same applies to display attributes.
+
+Additionally, you can duplicate the selected element with the copy icon under *Actions*.
+
+#### Special Elements
+
+Some element types have special properties:
+
+* *Date (formatted)* requires a string specifying the date format which will be passed to [`strftime(3)`](https://linux.die.net/man/3/strftime "man 3 strftime").
+* *Command* requires a string specifying the command to be executed.
+The prompt will contain the standard output of the command.
+  * The *Git branch* and *IP Address* elements are functionally equivalent to a *Command* element with the command already filled in.
+* *Text* requires an arbitrary string that will be included as is in the prompt.
+
 ## License
 
 Copyright (C) 2023 Scriptim