Skip to content

Commit c8ebfcb

Browse files
Update README.md
1 parent fb159ea commit c8ebfcb

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -247,14 +247,21 @@ You have 3 components: `$<module.submod>`, `${color}`, `$(bash command)`. They c
247247
e.g `$(echo \"hello world\" | cut -d' ' -f2)` will only print world
248248

249249
* **The color component (`${}`)** is used for which color to use for colorizing the text\
250-
e.g "${red}hello world" will indeed print "hello world" in red (or the color you set in the variable)\
251-
you can even put a custom hex color e.g: `${#ff6622}` (for bold text put ! before # e.g `${!#ff6622}`)\
252-
OR ANSI escape code colors e.g `${\e[1;32m}` or `"\e[38;5;160m` (NOTE: 256 colors ANSI escape codes, those that have \e[38 or \e[48, can't be used in GUI mode).\
250+
e.g `${red}hello world` will indeed print "hello world" in red (or the color you set in the variable).\
251+
The colors can be: <ins>black</ins>, <ins>red</ins>, <ins>green</ins>, <ins>blue</ins>, <ins>cyan</ins>, <ins>yellow</ins>, <ins>magenta</ins>, <ins>white</ins> and they can be configured in the config file.\
252+
You can put a custom hex color e.g: `${#ff6622}`.\
253+
It's possible to enable multiple options, put these symbols before `#`:\
254+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`b` - for making the color in the background\
255+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`u` - for underline the text\
256+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`!` - for making the text bold\
257+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`i` - for making the text italic\
258+
OR You can put ANSI escape code colors e.g `${\e[1;32m}` or `${\e[38;5;160m}`\
259+
(NOTE: 256 colors ANSI escape codes, those that have `\e[38` or `\e[48`, can't be used in GUI mode).\
253260
For auto coloring, depending on the ascii logo colors, use `${auto}`.\
254261
They can be used for different colors too. So for getting the 2nd color of the ascii logo,\
255262
use `${auto2}`, for the 4th one use `${auto4}` and so on.
256263

257-
Any $ or brackets can be escaped with \\
264+
Any `$` or brackets can be escaped with \\
258265

259266
# Thanks
260267
I would like to thanks:
@@ -269,6 +276,9 @@ I would like to thanks:
269276
* [fastfetch](https://github.com/fastfetch-cli/fastfetch/) and [neofetch](https://github.com/dylanaraps/neofetch),\
270277
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;For inspiring this project
271278

279+
* [{fmt}](https://github.com/fmtlib/fmt) and [toml++](https://github.com/marzer/tomlplusplus) libraries\
280+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Our favorite libraries that me and BurntRanch uses
281+
272282
* this string switch-case [library](https://github.com/xroche/stringswitch), \
273283
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Really amazing, thanks for making this
274284

0 commit comments

Comments
 (0)