Skip to content

Commit c77faa7

Browse files
committed
update doc
1 parent aef05ca commit c77faa7

File tree

4 files changed

+1089
-2459
lines changed

4 files changed

+1089
-2459
lines changed

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Design
4444
The DotMatrix theme use a couple of design principles:
4545

4646
* It is accessible to colorblind people, hence it uses:
47-
* only four colors: dark grey, white, blue and yellow.
47+
* only four colors: dark grey, white, blue and yellow (different color pairs are available as presets for people having blue-yellow colorblindess).
4848
* At least a text item for each segment,
4949
* or a blank space between segments.
5050
* 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:
5555
* Important states are denoted by text.
5656
* Ancillary states can be shown with a single character/icon.
5757
* States appearing from a user action can be shown by "detaching" two segments usually joined.
58-
When possible, this added space is shown as having a right-to-left direction.
58+
By default, this added space is shown as having a right-to-left direction.
5959

6060
The prompt itself is designed in three lines:
6161

@@ -82,9 +82,12 @@ for the default login user ("", a figure), on localhost ("", an island), i
8282

8383
### Full description
8484

85-
The following diagram shows almost all the possible states of a DotMatrix Liquid Prompt:
85+
The following diagram shows almost all the possible states of a DotMatrix Liquid Prompt
86+
87+
![](liquidprompt_dotmatrix_design.png)
88+
89+
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).
8690

87-
![](liquidprompt_dotmatrix_design.svg)
8891

8992

9093
Setup
@@ -97,7 +100,7 @@ For example:
97100

98101
# Load Liquid Prompt.
99102
source ~/liquidprompt/liquidprompt
100-
# Configure the desired variant.
103+
# Configure the desired variant (or colors, etc.).
101104
source ~/lp-dotmatrix/presets/variant-chevron.conf
102105
# Load the theme.
103106
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
110113
See the [Nerd-fonts Fonts installation docs](https://www.nerdfonts.com) for help on installing this kind of fonts.
111114

112115

113-
Variants
116+
Presets
114117
--------
115118

119+
The `presets` directory contains configurations changing several variables at once.
120+
It contains configuration files for changing the color pair (e.g. green/red instead of blue/yellow)
121+
and the segments shape (see below).
122+
123+
### Variants
124+
116125
Variants needing a Nerd-fonts font:
117126

118127
- "chevron" (the recommended one):

liquidprompt_dotmatrix_design.odt

11 KB
Binary file not shown.

liquidprompt_dotmatrix_design.png

138 KB
Loading

0 commit comments

Comments
 (0)