daylin/yartsu
1
0
Fork 0
mirror of https://github.com/daylinmorgan/yartsu.git synced 2024-12-22 04:20:44 -06:00
Code Issues Projects Releases Packages Wiki Activity

docs: update readme

Browse source
This commit is contained in:
Daylin Morgan 2022-06-14 18:52:30 -05:00
parent 5675209878
commit f5745c33ba
1 changed files with 36 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
README.md
View file

@ -1,9 +1,25 @@
# YARTSU
yartsu, another rich terminal screenshot utility
![YARTSU LOGO](https://github.com/daylinmorgan/yartsu/blob/main/assets/logo.svg)
![YARTSU HELP](https://github.com/daylinmorgan/yartsu/blob/main/assets/yartsu.svg)
<div id="top"></div>
<!-- PROJECT LOGO -->
<div align="center">
<a href="https://github.com/daylinmorgan/yartsu">
<img src="https://raw.githubusercontent.com/daylinmorgan/yartsu/main/assets/logo.svg" alt="Logo" width=600 >
</a>
<p align="center">
yartsu, another rich terminal screenshot utility
</p>
</div>
<br />
<!-- PROJECT SHIELDS -->
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
**NOTE**: this is a currently in a beta release and the API is subject to change (feedback welcome)
@ -25,6 +41,8 @@ pip install yartsu
## Usage
<div align="center"><img src="https://raw.githubusercontent.com/daylinmorgan/yartsu/main/assets/yartsu.svg" alt="Logo" width=600 ></div>
Getting a properly formatted output from a terminal screenshot is challenging.
There are three options for generating a screenshot.
@ -39,7 +57,7 @@ you to force ANSI color codes to be included even when piping output.
In these cases you can simply pipe the output directly into `yartsu`
```bash
ls --color=always / | yartsu -w 50 -o assets/ls_color.svg
ls --color=always | yartsu -w 50 -o assets/ls_color.svg
```
### Option 2: Subprocess/Pty
@ -60,7 +78,7 @@ Finally, if you neither of the above options work and you can
manage to preserve the codes in a plain text file you can pass this as input to `yartsu`.
```bash
ls --color / > ls.txt
ls --color > ls.txt
yartsu -w 50 -i ls.txt -o assets/ls_color.svg
```
@ -84,3 +102,16 @@ See [here](https://github.com/daylinmorgan/yartsu/blob/main/docs/themes.md) a pr
- [ ] add support for nerd-fonts
- [ ] add optional shadow
- [ ] add more themes
<!-- MARKDOWN LINKS & IMAGES -->
[contributors-shield]: https://img.shields.io/github/contributors/daylinmorgan/yartsu.svg?style=flat
[contributors-url]: https://github.com/daylinmorgan/yartsu/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/daylinmorgan/yartsu.svg?style=flat
[forks-url]: https://github.com/daylinmorgan/yartsu/network/members
[stars-shield]: https://img.shields.io/github/stars/daylinmorgan/yartsu.svg?style=flat
[stars-url]: https://github.com/daylinmorgan/yartsu/stargazers
[issues-shield]: https://img.shields.io/github/issues/daylinmorgan/yartsu.svg?style=flat
[issues-url]: https://github.com/daylinmorgan/yartsu/issues
[license-shield]: https://img.shields.io/github/license/daylinmorgan/yartsu.svg?style=flat
[license-url]: https://github.com/daylinmorgan/yartsu/blob/main/LICENSE.txt