From 421a31163aee9ec78bd064cdc700803baec47213 Mon Sep 17 00:00:00 2001 From: Daylin Morgan Date: Sat, 18 Jun 2022 17:09:10 -0500 Subject: [PATCH] docs: add reference to deviation from rich --- README.md | 5 ++++- docs/rich-diff.md | 4 ++-- scripts/rich-diff | 2 +- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 860eec0..f63ed0e 100644 --- a/README.md +++ b/README.md @@ -113,13 +113,16 @@ This should result in general support for emoji's and `nerd font` icons. **Note**: github won't load the font's when displaying on the README. Click on the `svg` to see the `nerd font` icons. +### Differences from [`Rich`](https://github.com/Textualize/rich) + +For both practical and stylistic reasons the underlying code used to generate the SVG is slightly different than `rich`'s default `save_svg` method. See [here](https://github.com/daylinmorgan/yartsu/blob/main/docs/rich-diff.md) for the current deviation between the latest releases of each respective release. + ## TODO - [ ] add unit tests - [x] add support for nerd-fonts - [x] add ~~optional~~ shadow -- [ ] add more themes diff --git a/docs/rich-diff.md b/docs/rich-diff.md index 9a7b927..46e92d2 100644 --- a/docs/rich-diff.md +++ b/docs/rich-diff.md @@ -4,7 +4,7 @@ ## Versions - Rich: 12.4.4 -- Yartsu: 22.6b4.dev3+gddae53c.d20220617 +- Yartsu: 22.6b5 ## CONSOLE_SVG_FORMAT Diff @@ -90,4 +90,4 @@ ``` -AUTO-GENERATED by code_svg_format_diff.py +AUTO-GENERATED by ./scripts/rich-diff diff --git a/scripts/rich-diff b/scripts/rich-diff index 5962d7e..5a2bce8 100755 --- a/scripts/rich-diff +++ b/scripts/rich-diff @@ -29,7 +29,7 @@ MARKDOWN_DOC = """ {export_svg_diff} ``` -AUTO-GENERATED by code_svg_format_diff.py""" +AUTO-GENERATED by ./scripts/rich-diff""" def unidiff_output(expected, actual):