Skip to content

Commit bf30a31

Browse files
committed
Improved documentation.
1 parent 79b9310 commit bf30a31

File tree

2 files changed

+19
-3
lines changed

2 files changed

+19
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,18 @@ System-Maintenance runs some system maintenance tasks to keep the system clean a
4848
- Updating firmware,
4949
- Trimming SSDs and virtual storage.
5050

51+
The typical usage is quite simple, e.g.:
52+
53+
``sudo System-Maintenance``
54+
5155
### Print-UTF8
5256

53-
Print-UTF8 is a simple program to print UTF-8 strings in the console with options for indentation, centering, separator as well as size/length/width information. It can e.g. be utilised for printing System-Info banners.
57+
Print-UTF8 is a simple program to print UTF-8 strings in the console with options for indentation, centering, separator as well as size/length/width information. It can e.g. be utilised for printing System-Info banners, or for displaying error messages like this classic Amiga [Guru Meditation](https://en.wikipedia.org/wiki/Guru_Meditation) example:
58+
59+
print-utf8 -n -s "\e[1;31;40;5m█" "▀" "█\e[0m"
60+
echo -e "Software Failure. Press left mouse button to continue.\nGuru Meditation #00000004.48454C50" | \
61+
print-utf8 -n -C "\e[1;31;40;5m█\e[25m" "\e[5m█\e[0m"
62+
print-utf8 -n -s "\e[1;31;40;5m█" "▄" "█\e[0m"
5463

5564
### Text-Block
5665

@@ -69,11 +78,13 @@ For example, the publications list in [index.html](https://www.nntb.no/~dreibh/i
6978

7079
### Fingerprint-SSH-Keys
7180

72-
Fingerprint-SSH-Keys prints the SSH key fingerprints of the local machine in different formats: SSH hash, DNS SSHFP RR, or Python dictionary.
81+
Fingerprint-SSH-Keys prints the SSH key fingerprints of the local machine in different formats: SSH hash, DNS SSHFP RR, or Python dictionary. Its typical usage is straightforward:
82+
83+
``Fingerprint-SSH-Keys``
7384

7485
### Configure-Grub
7586

76-
Configure-Grub adjusts a GRUB configuration file by applying a configuration from a template, and merging the existing configurations settings with additional customisations. It can for example be used to set a custom screen resolution (GRUB_GFXMODE option) or startup tune (GRUB_INIT_TUNE option).
87+
Configure-Grub adjusts a GRUB configuration file by applying a configuration from a template, and merging the existing configurations settings with additional customisations. It can for example be used to set a custom screen resolution (GRUB_GFXMODE option) or startup tune (GRUB_INIT_TUNE option). The [VM Image Builder Scripts](https://github.com/simula/nornet-vmimage-builder-scripts) use Configure-Grub to configure the screen resolution and a boot splash image.
7788

7889
### Try-Hard
7990

src/storage/guru-example

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,8 @@ print-utf8 -n -s "\e[1;31;40;5m█" "▀" "█\e[0m"
44
echo -e "Software Failure. Press left mouse button to continue.\nGuru Meditation #00000004.48454C50" | \
55
print-utf8 -n -C "\e[1;31;40;5m█\e[25m" "\e[5m█\e[0m"
66
print-utf8 -n -s "\e[1;31;40;5m█" "" "█\e[0m"
7+
8+
# To create the example image from 2 screenshots:
9+
# cwebp ~/Bilder/guru1.png guru1.webp
10+
# cwebp ~/Bilder/guru2.png guru2.webp
11+
# webpmux -frame guru1.webp +1000+0+0+0+b -frame guru2.webp +1000+0+0+0+b -o guru.webp

0 commit comments

Comments
 (0)