daylin/yartsu
1
0
Fork 0
mirror of https://github.com/daylinmorgan/yartsu.git synced 2024-09-20 01:47:17 -05:00
Code Issues Projects Releases Packages Wiki Activity

docs: add reference to deviation from rich

Browse source
This commit is contained in:
Daylin Morgan 2022-06-18 17:09:10 -05:00
parent ef03f6e0b7
commit 421a31163a
3 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -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. **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 ## TODO
- [ ] add unit tests - [ ] add unit tests
- [x] add support for nerd-fonts - [x] add support for nerd-fonts
- [x] add ~~optional~~ shadow - [x] add ~~optional~~ shadow
- [ ] add more themes
<!-- MARKDOWN LINKS & IMAGES --> <!-- MARKDOWN LINKS & IMAGES -->

4
docs/rich-diff.md
View file

@ -4,7 +4,7 @@
## Versions ## Versions
- Rich: 12.4.4 - Rich: 12.4.4
- Yartsu: 22.6b4.dev3+gddae53c.d20220617 - Yartsu: 22.6b5
## CONSOLE_SVG_FORMAT Diff ## CONSOLE_SVG_FORMAT Diff
@ -90,4 +90,4 @@
``` ```
AUTO-GENERATED by code_svg_format_diff.py AUTO-GENERATED by ./scripts/rich-diff

2
scripts/rich-diff
View file

@ -29,7 +29,7 @@ MARKDOWN_DOC = """
{export_svg_diff} {export_svg_diff}
``` ```
AUTO-GENERATED by code_svg_format_diff.py""" AUTO-GENERATED by ./scripts/rich-diff"""
def unidiff_output(expected, actual): def unidiff_output(expected, actual):