nsxiv7d87e6e
add related projects and some doc fixes (#170)
* README: add related projects Closes: https://github.com/nsxiv/nsxiv/issues/169 * fix readme feature section correct animations part (we support webp animation as well) and mention key-handler * remove duplicate Contribution Guideline heading
+19 −5
2 files changed
- M CONTRIBUTING.md +0 −3
- M README.md +19 −2
| @@ -1,6 +1,3 @@ | |||
| 1 | − | Contribution Guideline | |
| 2 | − | ---------------------- | |
| 3 | − | ||
| 4 | 1 | Project Scope | |
| 5 | 2 | ------------- | |
| 6 | 3 | ||
| @@ -22,10 +22,10 @@ Features | |||
| 22 | 22 | ||
| 23 | 23 | * Basic image operations, e.g. zooming, panning, rotating | |
| 24 | 24 | * Customizable key and mouse button mappings (in *config.h*) | |
| 25 | + | * Script-ability via `key-handler` | |
| 25 | 26 | * Thumbnail mode: grid of selectable previews of all images | |
| 26 | 27 | * Ability to cache thumbnails for fast re-loading | |
| 27 | − | * Basic support for multi-frame images | |
| 28 | − | * Play GIF animations | |
| 28 | + | * Basic support for animated/multi-frame images (GIF/WebP) | |
| 29 | 29 | * Display image information in status bar | |
| 30 | 30 | * Display image name/path in X title | |
| 31 | 31 | ||
| @@ -182,3 +182,20 @@ on GitHub or get a copy using git with the following command: | |||
| 182 | 182 | $ git clone https://github.com/nsxiv/nsxiv.git | |
| 183 | 183 | ||
| 184 | 184 | You can view the changelog [here](CHANGELOG.md) | |
| 185 | + | ||
| 186 | + | Related projects | |
| 187 | + | ---------------- | |
| 188 | + | ||
| 189 | + | If nsxiv isn't able to fit your needs, check out the image viewer section of | |
| 190 | + | [suckless rocks](https://suckless.org/rocks) to find other minimal image viewers | |
| 191 | + | to try out. | |
| 192 | + | ||
| 193 | + | Below are a couple other lesser known projects not listed in suckless rocks. | |
| 194 | + | ||
| 195 | + | * [MAGE](https://github.com/explosion-mental/mage) : | |
| 196 | + | Aims to be a smaller/more-suckless version of sxiv. | |
| 197 | + | * [div](https://github.com/TAAPArthur/div) : | |
| 198 | + | Minimal and extensive, aimed at C devs willing to build their own features. | |
| 199 | + | * [mpv-image-viewer](https://github.com/occivink/mpv-image-viewer) : | |
| 200 | + | Lua script to turn mpv into an image viewer. Supports thumbnails via | |
| 201 | + | [mpv-gallery-view](https://github.com/occivink/mpv-gallery-view). | |