From 0fa37082be3ca2eda4754fc3ea02e92d4ac7ded7 Mon Sep 17 00:00:00 2001 From: Daylin Morgan Date: Wed, 15 Jun 2022 02:11:32 -0500 Subject: [PATCH] docs: add font/emoji info --- Makefile | 10 ++++++++- README.md | 10 +++++++++ assets/demo.svg | 60 +++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 79 insertions(+), 1 deletion(-) create mode 100644 assets/demo.svg diff --git a/Makefile b/Makefile index 1d256cf..f7cfeb1 100644 --- a/Makefile +++ b/Makefile @@ -23,7 +23,7 @@ build/yartsu: $(SRC_FILES) install-bin: build/yartsu cp ./build/yartsu ~/bin -docs: svg-docs theme-docs +docs: svg-docs theme-docs demo-docs theme-docs: ./scripts/theme-showcase-gen @@ -32,6 +32,14 @@ svg-docs: lolcat -F .5 -S 9 -f assets/logo.txt | yartsu -o assets/logo.svg yartsu -o assets/yartsu.svg -t "yartsu --help" -- yartsu -h +demo-docs: + python -c \ + "from rich.console import Console; \ + console = Console(force_terminal=True); \ + console.print('\n:snake: [b i]Emoji\'s!'); \ + console.print(' [cyan]Nerd Fonts!');" \ + | yartsu -w 25 -o assets/demo.svg + # https://stackoverflow.com/a/26339924 list: @LC_ALL=C $(MAKE) -pRrq -f $(lastword $(MAKEFILE_LIST)) : 2>/dev/null | awk -v RS= -F: '/^# File/,/^# Finished Make data base/ {if ($$1 !~ "^[#.]") {print $$1}}' | sort | egrep -v -e '^[^[:alnum:]]' -e '^$@$$' diff --git a/README.md b/README.md index bfa1139..c4d36cc 100644 --- a/README.md +++ b/README.md @@ -108,6 +108,16 @@ You may also use the environment variable `YARTSU_THEME`. See [here](https://github.com/daylinmorgan/yartsu/blob/main/docs/themes.md) a preview of the available themes +### Supported Characters + +Currently `yartsu` loads the `nerd font` patched FiraCode font. +This should result in general support for emoji's and `nerd font` icons. + +
Logo
+ +**Note**: github won't load the font's when displaying on the README. Click on the `svg` to see the `nerd font` icons. + + ## TODO - [ ] add unit tests diff --git a/assets/demo.svg b/assets/demo.svg new file mode 100644 index 0000000..60f08b9 --- /dev/null +++ b/assets/demo.svg @@ -0,0 +1,60 @@ + + + + + + + + + + + + + + + yartsu + + + + + + + + + + +🐍 Emoji's! +  Nerd Fonts! + + + +