Skip to content

Commit

Permalink
Merge pull request #46 from iambumblehead/add-gzip-filesize-update-ba…
Browse files Browse the repository at this point in the history
…dge-arrangement

update readme
  • Loading branch information
iambumblehead authored Mar 21, 2024
2 parents eddc987 + 81f4350 commit 077aae9
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 12 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
* separate [image-generation from image-display.](https://github.com/iambumblehead/thu.sh/pull/42) Will allow more control with caching and session state, testing etc.
* detect foot version lte 1.16.2 and [show warning message.](https://github.com/iambumblehead/thu.sh/pull/43)
* improve stored [state usage (so that it works with vifm)](https://github.com/iambumblehead/thu.sh/pull/44)
* added [size badge to README](https://github.com/iambumblehead/thu.sh/pull/46)
* 0.0.7 _Mar.14.2024_
* improve [support for xterm](https://github.com/iambumblehead/thu.sh/pull/25)
* added [support for cell units](https://github.com/iambumblehead/thu.sh/pull/26)
Expand Down
19 changes: 7 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
<h3 align="center"><img src="./test/render-for.demo.gif" alt="demo" height="400px"></h3>
<p align="center"><code>thu.sh</code> renders preview images to the terminal; ~1000 LOC bash</p>
<p align="center">
<a href="https://github.com/iambumblehead/thu.sh/workflows"><img src="https://github.com/iambumblehead/thu.sh/workflows/test/badge.svg"></a>
<a href="./thu.sh"><img src="https://img.badgesize.io/iambumblehead/thu.sh/main/thu.sh.svg?compression=gzip"></a>
<a href="https://github.com/iambumblehead/thu.sh/workflows"><img src="https://img.shields.io/badge/tests-passing-brightgreen.svg"></a>
<a href="./LICENSE.md"><img src="https://img.shields.io/badge/license-GPLv3-blue.svg"></a>
<a href="https://github.com/iambumblehead/thu.sh/releases"><img src="https://img.shields.io/github/release/iambumblehead/thu.sh.svg"></a>
</p>

> [!WARNING]
> This project has no major releases and sources will change suddenly any time. Few unit tests at this time.
**thu.sh renders images for various file types to the terminal.** It renders images from audio, font, video, pdf, epub, svg and other files --supporting both kitty and sixel formats. It detects available commands from the system for a small dependency tree,
**thu.sh renders images from audio, font, video, pdf, epub, svg** and other files --supporting both kitty and sixel formats. It detects available commands from the system for a small dependency tree,
* `magick` sixel or `kitten icat` display,
* `mutool`, `pdftoppm` or `magick` pdf,
* `ffmpeg` video audio,
Expand Down Expand Up @@ -41,15 +39,12 @@ thu.sh /path/to/book.epub

----------------------------------------------

**Add sixel image preview** to the [vifm file manager.][3] Instructions [at the wiki.][3]
**Add sixel image preview** to [vifm file manager.][10] Instructions [at the wiki.][11]

<div align="left">
<img src="./test/render-for-vifm.gif" alt="vifm" height="240px"> <img src="./test/render-for-miller.png" alt="vifm" height="240px">
<img src="./test/render-for-vifm.gif" alt="vifm" height="220px"> <img src="./test/render-for-miller.png" alt="vifm" height="220px">
</div>



[0]: https://img.shields.io/badge/license-ISC-blue.svg
[1]: ./LICENSE
[2]: https://github.com/vifm/vifm
[3]: https://github.com/iambumblehead/thu.sh/wiki
[10]: https://github.com/vifm/vifm
[11]: https://github.com/iambumblehead/thu.sh/wiki

0 comments on commit 077aae9

Please sign in to comment.