D README.html

@@ -1,34 +0,0 @@ 
-<h1>Rainbow Bash Prompt</h1>
-<style>
-    code span {
-        font-family: inherit!important;
-    }
-</style>
-<h2>html estimate output:</h2>
-<pre><code class="terminal"><span style="background-color:#D7AF00!important;"><span style="color: #AFFFAF!important;">▄</span></span><span style="background-color:#D75F00!important;"><span style="color: #5F0000!important;">▄</span></span><span style="color: #875FFF!important;">|</span><span style="color: #FF5F00!important;">0</span><span style="color: #00FFFF!important;"> </span><span style="color: #0095FF!important;">1</span><span style="color: #002BFF!important;">7</span> <span style="color: #0000FF!important;">:</span><span style="color: #6A00FF!important;">3</span><span style="color: #D400FF!important;"> </span><span style="color: #FF0095!important;">p</span><span style="color: #FF002B!important;">r</span><span style="color: #FF0000!important;">o</span><span style="color: #FF6A00!important;">j</span><span style="color: #FFD400!important;">e</span><span style="color: #FFFF00!important;">c</span><span style="color: #95FF00!important;">t</span><span style="color: #2BFF00!important;"> </span><span style="color: #00FF6A!important;">b</span><span style="color: #00FFD4!important;">a</span><span style="color: #00FFFF!important;">s</span><span style="color: #0095FF!important;">h</span><span style="color: #002BFF!important;">p</span><span style="color: #0000FF!important;">r</span><span style="color: #6A00FF!important;">o</span><span style="color: #D400FF!important;">m</span><span style="color: #FF0095!important;">p</span><span style="color: #FF002B!important;">t</span> <span style="color: #FF0000!important;">$</span> 
-<span style="background-color:#D7AF00!important;"><span style="color: #AFFFAF!important;">▄</span></span><span style="background-color:#D75F00!important;"><span style="color: #5F0000!important;">▄</span></span><span style="color: #875FFF!important;">&nbsp;</span><span style="color: #FF5F00!important;">0</span><span style="color: #0000FF!important;"> </span><span style="color: #6A00FF!important;">1</span><span style="color: #D400FF!important;">8</span> <span style="color: #FF0095!important;">;</span><span style="color: #FF002B!important;">&gt;</span><span style="color: #FF0000!important;"> </span><span style="color: #FF6A00!important;">p</span><span style="color: #FFD400!important;">r</span><span style="color: #FFFF00!important;">o</span><span style="color: #95FF00!important;">j</span><span style="color: #2BFF00!important;">e</span><span style="color: #00FF6A!important;">c</span><span style="color: #00FFD4!important;">t</span><span style="color: #00FFFF!important;"> </span><span style="color: #0095FF!important;">b</span><span style="color: #002BFF!important;">a</span><span style="color: #0000FF!important;">s</span><span style="color: #6A00FF!important;">h</span><span style="color: #D400FF!important;">p</span><span style="color: #FF0095!important;">r</span><span style="color: #FF002B!important;">o</span><span style="color: #FF0000!important;">m</span><span style="color: #FF6A00!important;">p</span><span style="color: #FFD400!important;">t</span> <span style="color: #FFFF00!important;">$</span> cd build/
-<span style="background-color:#D7AF00!important;"><span style="color: #AFFFAF!important;">▄</span></span><span style="background-color:#D75F00!important;"><span style="color: #5F0000!important;">▄</span></span><span style="color: #875FFF!important;">&nbsp;</span><span style="color: #FF5F00!important;">0</span><span style="color: #FF0095!important;"> </span><span style="color: #FF002B!important;">1</span><span style="color: #FF0000!important;">9</span> <span style="color: #FF6A00!important;">:</span><span style="color: #FFD400!important;">&gt;</span><span style="color: #FFFF00!important;"> </span><span style="color: #95FF00!important;">b</span><span style="color: #2BFF00!important;">a</span><span style="color: #00FF6A!important;">s</span><span style="color: #00FFD4!important;">h</span><span style="color: #00FFFF!important;">p</span><span style="color: #0095FF!important;">r</span><span style="color: #002BFF!important;">o</span><span style="color: #0000FF!important;">m</span><span style="color: #6A00FF!important;">p</span><span style="color: #D400FF!important;">t</span><span style="color: #FF0095!important;"> </span><span style="color: #FF002B!important;">b</span><span style="color: #FF0000!important;">u</span><span style="color: #FF6A00!important;">i</span><span style="color: #FFD400!important;">l</span><span style="color: #FFFF00!important;">d</span> <span style="color: #95FF00!important;">$</span> false
-<span style="background-color:#D7AF00!important;"><span style="color: #AFFFAF!important;">▄</span></span><span style="background-color:#D75F00!important;"><span style="color: #5F0000!important;">▄</span></span><span style="color: #875FFF!important;">&nbsp;</span><span style="color: #FF5F00!important;">1</span><span style="color: #FF002B!important;"> </span><span style="color: #FF0000!important;">2</span><span style="color: #FF6A00!important;">0</span> <span style="color: #FFD400!important;">:</span><span style="color: #FFFF00!important;">)</span><span style="color: #95FF00!important;"> </span><span style="color: #2BFF00!important;">b</span><span style="color: #00FF6A!important;">a</span><span style="color: #00FFD4!important;">s</span><span style="color: #00FFFF!important;">h</span><span style="color: #0095FF!important;">p</span><span style="color: #002BFF!important;">r</span><span style="color: #0000FF!important;">o</span><span style="color: #6A00FF!important;">m</span><span style="color: #D400FF!important;">p</span><span style="color: #FF0095!important;">t</span><span style="color: #FF002B!important;"> </span><span style="color: #FF0000!important;">b</span><span style="color: #FF6A00!important;">u</span><span style="color: #FFD400!important;">i</span><span style="color: #FFFF00!important;">l</span><span style="color: #95FF00!important;">d</span> <span style="color: #2BFF00!important;">$</span> [[ &quot;str&quot; == &quot;str&quot; ]]
-<span style="background-color:#D7AF00!important;"><span style="color: #AFFFAF!important;">▄</span></span><span style="background-color:#D75F00!important;"><span style="color: #5F0000!important;">▄</span></span><span style="color: #875FFF!important;">&nbsp;</span><span style="color: #FF5F00!important;">0</span><span style="color: #FF002B!important;"> </span><span style="color: #FF0000!important;">2</span><span style="color: #FF6A00!important;">1</span> <span style="color: #FFD400!important;">;</span><span style="color: #FFFF00!important;">P</span><span style="color: #95FF00!important;"> </span><span style="color: #2BFF00!important;">b</span><span style="color: #00FF6A!important;">a</span><span style="color: #00FFD4!important;">s</span><span style="color: #00FFFF!important;">h</span><span style="color: #0095FF!important;">p</span><span style="color: #002BFF!important;">r</span><span style="color: #0000FF!important;">o</span><span style="color: #6A00FF!important;">m</span><span style="color: #D400FF!important;">p</span><span style="color: #FF0095!important;">t</span><span style="color: #FF002B!important;"> </span><span style="color: #FF0000!important;">b</span><span style="color: #FF6A00!important;">u</span><span style="color: #FFD400!important;">i</span><span style="color: #FFFF00!important;">l</span><span style="color: #95FF00!important;">d</span> <span style="color: #2BFF00!important;">$</span> [[ &quot;str&quot; == &quot;strs&quot; ]]
-<span style="background-color:#D7AF00!important;"><span style="color: #AFFFAF!important;">▄</span></span><span style="background-color:#D75F00!important;"><span style="color: #5F0000!important;">▄</span></span><span style="color: #875FFF!important;">&nbsp;</span><span style="color: #FF5F00!important;">1</span><span style="color: #FF0095!important;"> </span><span style="color: #FF002B!important;">2</span><span style="color: #FF0000!important;">2</span> <span style="color: #FF6A00!important;">;</span><span style="color: #FFD400!important;">&gt;</span><span style="color: #FFFF00!important;"> </span><span style="color: #95FF00!important;">b</span><span style="color: #2BFF00!important;">a</span><span style="color: #00FF6A!important;">s</span><span style="color: #00FFD4!important;">h</span><span style="color: #00FFFF!important;">p</span><span style="color: #0095FF!important;">r</span><span style="color: #002BFF!important;">o</span><span style="color: #0000FF!important;">m</span><span style="color: #6A00FF!important;">p</span><span style="color: #D400FF!important;">t</span><span style="color: #FF0095!important;"> </span><span style="color: #FF002B!important;">b</span><span style="color: #FF0000!important;">u</span><span style="color: #FF6A00!important;">i</span><span style="color: #FFD400!important;">l</span><span style="color: #FFFF00!important;">d</span> <span style="color: #95FF00!important;">$</span>
-</code></pre>
-<h2>Installation</h2>
-<pre><code class="terminal">
-make
-sudo install ./build/bashprompt /usr/local/bin/bashprompt
-/usr/local/bin/bashprompt help
-</code></pre>
-<p>
-Ensure that the file is executable and that you use an absolute path to the file.
-Copy the output to your .bashrc for automatic start up. <b>DO NOT</b> USE .bash_profile or .profile.
-</p>
-
-<h2>Options:</h2>
-Environment variables can be set to customize the prompt.
-
-<pre><code class="terminal">IPCOLOR=alt</code></pre>
-<p>IP address will be colored with an alternate color palette.</p>
-
-<pre><code class="terminal">IPCOLOR=none</code></pre>
-<p>IP address and username will not be printed.</p>
-

M README.md → README.md

@@ -1,13 +1,42 @@ 
 # Rainbow Bash Prompt
+An extension for bash that generates a rainbow-colored PS1 with IP address shown as 4 blocks of color.
 
-## Installation
+## Install with apt (ubuntu/debian)
+### Add the repository
+You can add the repository by running the following command:
+```bash
+sudo wget -O /usr/share/keyrings/soph-deb.gpg "https://cdn.sophuwu.com/deb/key.gpg" && echo 'deb [signed-by=/usr/share/keyrings/soph-deb.gpg] https://cdn.sophuwu.com/deb/ sophuwu main' | sudo tee /etc/apt/sources.list.d/sophdeb.list
+```
+This script will do the same thing:
+```bash
+curl https://cdn.sophuwu.com/deb/addrepo.sh | sudo sh
+```
+### Install the "bash-rb-ps1" package   
+```bash
+sudo apt update
+sudo apt install bash-rb-ps1
+```
+## Run for the first time
+This will only work if you are using bash with xterm-like escape sequences. You can enable the generator
+by running:
+```bash
+eval $(bash-rb-ps1 help)
+```
+If you experience an error, or want to disable the prompt, you can run:
+```bash
+unset PROMPT_COMMAND
+PS1='${debian_chroot:+($debian_chroot)}\u@\h:\w\$ '
+```
+To see help and other information about the command, use:
+```bash
+man bash-rb-ps1.1
+```
+## Compile from source
 ```bash
 make
-sudo install ./build/bashprompt /usr/local/bin/bashprompt
-/usr/local/bin/bashprompt help
+sudo install ./build/bashprompt /usr/local/bin/bash-rb-ps1
+sudo install ./releaser/bash-rb-ps1.1 /usr/local/share/man/man1/bash-rb-ps1.1
 ```
-Ensure that the file is executable and that you use an absolute path to the file.
-Copy the output to your .bashrc for automatic start up. **DO NOT** USE .bash_profile or .profile.
 
 ## Options:
 Environment variables can be set to customize the prompt.
@@ -15,5 +44,7 @@ 
 * `IPCOLOR=alt` IP address will be colored with an alternate color palette.
 * `IPCOLOR=none` IP address and username will not be printed.
 
+## Preview
 
+<img src="https://cdn.sophuwu.com/img/bash-rb-ps1.png" alt="Rainbow Bash Prompt" style="display: block; margin: auto; height: 45lh;" />