feat(doc): Makefile for making screenshots

This commit is contained in:
Johann Dreo 2023-11-15 06:58:01 +01:00
commit 4c506c9365
24 changed files with 25 additions and 27 deletions

15
Makefile Normal file
View file

@ -0,0 +1,15 @@
LP ?= /home/nojhan/code/liquidprompt
HEIGHT := 450
THEME := dotmatrix dotmatrix.theme
ALL := $(addprefix screenshots/,variant-chevron.png variant-round.png variant-slant.png variant-text.png variant-chevron_colors-cyan-magenta.png variant-chevron_colors-green-red.png variant-chevron_colors-high-contrast.png)
.PHONY: all
all: Makefile $(ALL)
clean:
rm -f $(ALL)
%.png:
$(LP)/tools/theme-screenshot.sh $(HEIGHT) $(THEME) $(addprefix presets/,$(addsuffix .conf, $(subst _, ,$(basename $(notdir $@))))) > $@

View file

@ -17,23 +17,14 @@ But we believe that the advantages of this design makes it worth the effort.
Preview Preview
------- -------
If there is nothing special about the current context, the appearance of Using the (recommended) "chevron" preset:
DotMatrix might be as simple as this:
![](screenshots/dotmatrix-short-chevron.png) ![](screenshots/variant-chevron.png)
A typical display of a slightly complex session would look like this:
![](screenshots/dotmatrix-med-chevron.png)
The DotMatrix theme also comes as several variants, changing the shape of the segments separators, The DotMatrix theme also comes as several variants, changing the shape of the segments separators,
like the (default) "dotmatrix" pixels: like the "slant" variant:
![](screenshots/dotmatrix-short-dots.png) ![](screenshots/variant-slant.png)
or the "slant" variant:
![](screenshots/dotmatrix-med-slant.png)
Design Design
@ -72,7 +63,7 @@ For instance, in the following prompt, you can see that the user is in a Git rep
- the rightmost blue "≠" indicates that there are some modifications waiting to be commited (hence the directional hint, from a diff to the branch). - the rightmost blue "≠" indicates that there are some modifications waiting to be commited (hence the directional hint, from a diff to the branch).
- the leftmost blue segment indicates that there are some commits that may be pushed to the remote (hence the directional hint, from the branch to the VCS symbol). - the leftmost blue segment indicates that there are some commits that may be pushed to the remote (hence the directional hint, from the branch to the VCS symbol).
![](screenshots/dotmatrix-intro-chevron.png) ![](screenshots/variant-chevron.png)
The screenshot also shows that the last command ended in an error, hence the red-over-yellow error code. The screenshot also shows that the last command ended in an error, hence the red-over-yellow error code.
@ -126,25 +117,25 @@ Variants needing a Nerd-fonts font:
- "chevron" (the recommended one): - "chevron" (the recommended one):
![](screenshots/dotmatrix-short-chevron.png) ![](screenshots/varint-chevron.png)
- "round": - "round":
![](screenshots/dotmatrix-short-round.png) ![](screenshots/variant-round.png)
- "slant": - "slant":
![](screenshots/dotmatrix-short-slant.png) ![](screenshots/variant-slant.png)
Variants available with a regular font: Variants available with a regular font:
- "dotmatrix" (the default): - "dotmatrix" (the default):
![](screenshots/dotmatrix-short-dots.png) ![](screenshots/variant-dots.png)
- "text" (using only common characters): - "text" (using only common characters):
![](screenshots/dotmatrix-short-text.png) ![](screenshots/variant-text.png)
Configuration Configuration
@ -204,14 +195,6 @@ A second set changes the colors:
If set to false, this flag will configure a compact prompt, If set to false, this flag will configure a compact prompt,
showing segments without extra spaces around their joints. showing segments without extra spaces around their joints.
Example of a spaced prompt:
![](screenshots/dotmatrix-spaced.png)
Example of a compact prompt:
![](screenshots/dotmatrix-unspaced.png)
#### Specific features #### Specific features

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB