diff --git a/README.md b/README.md index 2130ec5..4afaee3 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ Design The DotMatrix theme use a couple of design principles: * It is accessible to colorblind people, hence it uses: - * only four colors: dark grey, white, blue and yellow. + * only four colors: dark grey, white, blue and yellow (different color pairs are available as presets for people having blue-yellow colorblindess). * At least a text item for each segment, * or a blank space between segments. * The blue colors means that the user is probably expected to perform some task. @@ -55,7 +55,7 @@ The DotMatrix theme use a couple of design principles: * Important states are denoted by text. * Ancillary states can be shown with a single character/icon. * States appearing from a user action can be shown by "detaching" two segments usually joined. - When possible, this added space is shown as having a right-to-left direction. + By default, this added space is shown as having a right-to-left direction. The prompt itself is designed in three lines: @@ -82,9 +82,12 @@ for the default login user ("", a figure), on localhost ("", an island), i ### Full description -The following diagram shows almost all the possible states of a DotMatrix Liquid Prompt: +The following diagram shows almost all the possible states of a DotMatrix Liquid Prompt + +![](liquidprompt_dotmatrix_design.png) + +The diagram is available [in a vector format](liquidprompt_dotmatrix_design.svg) (note: you need a browser/viewer configured to use a [nerd-font](https://www.nerdfonts.com) to see it correctly). -![](liquidprompt_dotmatrix_design.svg) Setup @@ -97,7 +100,7 @@ For example: # Load Liquid Prompt. source ~/liquidprompt/liquidprompt - # Configure the desired variant. + # Configure the desired variant (or colors, etc.). source ~/lp-dotmatrix/presets/variant-chevron.conf # Load the theme. source ~/lp-dotmatrix/dotmatrix.theme && lp_theme dotmatrix @@ -110,9 +113,15 @@ You will either need a compatible font, or use a variant that does not need them See the [Nerd-fonts Fonts installation docs](https://www.nerdfonts.com) for help on installing this kind of fonts. -Variants +Presets -------- +The `presets` directory contains configurations changing several variables at once. +It contains configuration files for changing the color pair (e.g. green/red instead of blue/yellow) +and the segments shape (see below). + +### Variants + Variants needing a Nerd-fonts font: - "chevron" (the recommended one): diff --git a/liquidprompt_dotmatrix_design.odt b/liquidprompt_dotmatrix_design.odt index e77809b..ec78ff1 100644 Binary files a/liquidprompt_dotmatrix_design.odt and b/liquidprompt_dotmatrix_design.odt differ diff --git a/liquidprompt_dotmatrix_design.png b/liquidprompt_dotmatrix_design.png new file mode 100644 index 0000000..9668b37 Binary files /dev/null and b/liquidprompt_dotmatrix_design.png differ diff --git a/liquidprompt_dotmatrix_design.svg b/liquidprompt_dotmatrix_design.svg index 4ce4f3f..5afd105 100644 --- a/liquidprompt_dotmatrix_design.svg +++ b/liquidprompt_dotmatrix_design.svg @@ -4,3927 +4,2548 @@ - - - - - - - - - - - - - - - localhost - - - localhostlogged│ home - - - logged│ home┌┴┐┌┴┐┌┴┐ - - ┌┴┐┌┴┐┌┴┐ - - X - - - X█ - - █ - - - - - - █ - - █ - - - - - - - - - - - - █ - - █ - - ⌂ - - ⌂ - - - - - - - - ~ - - ~ - - -   - - -  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - - △ - - - △ - - - - - - - ├┘ - - - ├┘no-internet - - - no-internetadmin remote dirstack detached suspended - - - admin remote dirstack detached suspendedX su │ tmux │ RO VCS root cwd │ recall batt load temp │ bg │shell time - - - X su │ tmux │ RO VCS root cwd │ recall batt load temp │ bg │shell time├┐┌┴┐┌─┴─┐┌┴┐┌──┴──┐┌┴┐ ┌─────┴─────┐ ┌───┴────┐ ┌┴┐├┐ ┌┴─┐┌─┴─┐┌─┴┐ ┌┴┐┌┴┐┌┴┐┌┴┐ ┌───┴───┐ - - - ├┐┌┴┐┌─┴─┐┌┴┐┌──┴──┐┌┴┐ ┌─────┴─────┐ ┌───┴────┐ ┌┴┐├┐ ┌┴─┐┌─┴─┐┌─┴┐ ┌┴┐┌┴┐┌┴┐┌┴┐ ┌───┴───┐ - - X - - - X█ - - - █ - - - - █ - - █ - - root - - root - - █ - - - █ - - - - - - - █ - - █ - - server - - server - - █ - - - █ - - - - - - - - - ~ - - ~ - - ╱ - - ╱ - - code - - code - - ╱ - - ╱ - - liquidprompt - - - liquidprompt - - - - ╱ - - ╱ - - theme - - theme - - ╱ - - ╱ - - dotmatrix - - dotmatrix - - - - - - █ - - █ - - 2 - - - 2 - - - - - -  - -  - - 24% - - 24% - - ╱ - - ╱ - - 1.68 - - 1.68 - - ╱ - - ╱ - - 90° - - 90° - - - - - - 3d - - 3d - - ╱ - - ╱ - - 2& - - 2& - - ╱ - - ╱ - - 1z - - 1z - - - - - - - - b - - b - - - - - - - - 15:20:34 - - - ━ - - - - - - scl0 - - - ┃ - - - - scl1 - - - - - - ━ - - - - - - venv - - - - - - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - - - - - - ls -al - - - ┃ - - - - git - - - - - - ━ - - - - - - - - - - - - - - - - ± - - - - - - - - - - - - ➒ - - - - - - - - - - - - main - - - - : - - - - feat - - - - ╱ - - - - v0.1 - - - - - - - - - - - - - - + - - - - ➁ - - - - ╱ - - - - - - - - - ⁺ - ⑳ - - - - - - - - - - ✞ - - - - ╱ - - - - ⛶ - - - - ╱ - - - - detached - - - - 15:20:34 - - ━scl0 ┃scl1 ━venv ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ls -al ┃git ━± ➒main:feat╱v0.1+➁╱-⁺⑳✞╱⛶╱detached - - - - 20s - - 20s - - - - - - - - - - - - - - 125 - - - 125 - - - - - - - - └ - - - ─ - - - ┬ - - - ── - - - ┘ └ - - - ─ - - - ┬ - - - ─ - - - ┘ - - - └─┬──┘ └─┬─┘├┘ └┬┘ ├┘└──┬┘└─┬──┘└─┬┘└─┬─┘ ├┘└───┬───┘└┬┘└┬┘└───┬───┘└┬─┘ └─┬─┘ ├┘ last most - - - ├┘ └┬┘ ├┘└──┬┘└─┬──┘└─┬┘└─┬─┘ ├┘└───┬───┘└┬┘└┬┘└───┬───┘└┬─┘ └─┬─┘ ├┘ last most│ VCS push!│ │bookmark │ commit! │ stash │ head st. Runtime │ sudo - - - │ VCS push!│ │bookmark │ commit! │ stash │ head st. Runtime │ sudoitnet commits branch tag diff untracked error - - - itnet commits branch tag diff untracked errorssh - - - sshtxt│ guest FQDN chroot shorten - - - txt│ guest FQDN chroot shorten├┐┌┴┐┌──┴───┐ ┌────┴─────┐┌┴┐ ┌┴┐ - - - ├┐┌┴┐┌──┴───┐ ┌────┴─────┐┌┴┐ ┌┴┐ - - T █rycieoshost.fq.dn T - - -  - - - - - - - █ - - - - rycieos - - - - - - - - - - host.fq.dn - - -  - - -  - - - - █ - - █ - - - - ~ - - ~ - - ╱ - - ╱ - - code - - code - - ╱ - - ╱ - - … - - … - - ╱ - - ╱ - - files - - - files   - -   - - - - - ━ - - - ━ - - - pyenv - - - pyenv - - - ━━━━ - - - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - - △ - - △ - - - - - - █ - - █ - - 1 - - - 1 - - -  - - - - └┬┘ - - -  ├┘└┬┘shell-level - - - pull! shell-levelTag - - - Tag│ telnet chroot + RO warning recall too much - - - │ telnet chroot + RO warning recall too much├┐┌─┴─┐ ┌─┴──┐ ┌┴┐ ┌─┴─┐ - - - ├┐┌─┴─┐ ┌─┴──┐ ┌┴┐ ┌─┴─┐ - - T - - - T █nojhanhost - - -  - - -  - - - - █ - - - - nojhan - - - - - - - - - - host - - - - - -  - - - - - - - █ - - █ - - - - ~ - - ~ - - ╱ - - ╱ - - code - - code - - ╱ - - ╱ - - … - - … - - ╱ - - ╱ - - here - - - here - - -  - - - -  - -  - - - - - - - - 3d - - - - - - - - - - 15:20:34 - - - GIT ━ - - - - - - devtoolset-8 - - - - - - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - - - - - - - - - - - - - - - - - - - - ± - - - - - - - - - - main - - - - - - - - - - - - - - + - - - - ➁ - - - - ╱ - - - - -⁺ - ⑳ - - - - - - - - - └┬┘ └───┬───┘ - - - proxy too much - - - Generic example: - - - - X - - - █ - - - - - - - - █ - - - - - - - - - - - - - - █ - - - - ⌂ - - - - - - - - - - ~ - - - - - - ╱ - - - - code - - - - ╱ - - - - liquidprompt - - - - - - - ╱ - - - - theme - - - - ╱ - - - - dotmatrix - - - - - -  - - -  - - - - - - - - - - 5d - - 3d - - - - 15:20:34GIT ━devtoolset-8 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━± main+➁╱-⁺⑳└┬┘ └───┬───┘proxy too muchGeneric example:X███⌂ ~╱ code ╱ liquidprompt ╱ theme ╱ dotmatrix 5d - - - - 15:20:34 - - - 15:20:34━━━━━━━━━━━━━━ - - - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - - ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ - - - - - - - - - - - - - - ± - - - ± ≠dotmatrix - - - - - - - - - ≠ - - - - - - - - - - - - dotmatrix - - - - - - - - - - - - - - ≠ - - ≠ - - - - - - - - - - ✞ - - - ✞ - - - -  - - -  - - - ⚀⚁⚂⚃⚄⚅ - - - - - - + id="tspan1998">