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
This commit is contained in:
N-R-K 2021-11-23 13:27:14 +06:00 committed by GitHub
parent c6275374b0
commit 7d87e6e412
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 5 deletions

View File

@ -1,6 +1,3 @@
Contribution Guideline
----------------------
Project Scope Project Scope
------------- -------------

View File

@ -22,10 +22,10 @@ Features
* Basic image operations, e.g. zooming, panning, rotating * Basic image operations, e.g. zooming, panning, rotating
* Customizable key and mouse button mappings (in *config.h*) * Customizable key and mouse button mappings (in *config.h*)
* Script-ability via `key-handler`
* Thumbnail mode: grid of selectable previews of all images * Thumbnail mode: grid of selectable previews of all images
* Ability to cache thumbnails for fast re-loading * Ability to cache thumbnails for fast re-loading
* Basic support for multi-frame images * Basic support for animated/multi-frame images (GIF/WebP)
* Play GIF animations
* Display image information in status bar * Display image information in status bar
* Display image name/path in X title * Display image name/path in X title
@ -182,3 +182,20 @@ on GitHub or get a copy using git with the following command:
$ git clone https://github.com/nsxiv/nsxiv.git $ git clone https://github.com/nsxiv/nsxiv.git
You can view the changelog [here](CHANGELOG.md) You can view the changelog [here](CHANGELOG.md)
Related projects
----------------
If nsxiv isn't able to fit your needs, check out the image viewer section of
[suckless rocks](https://suckless.org/rocks) to find other minimal image viewers
to try out.
Below are a couple other lesser known projects not listed in suckless rocks.
* [MAGE](https://github.com/explosion-mental/mage) :
Aims to be a smaller/more-suckless version of sxiv.
* [div](https://github.com/TAAPArthur/div) :
Minimal and extensive, aimed at C devs willing to build their own features.
* [mpv-image-viewer](https://github.com/occivink/mpv-image-viewer) :
Lua script to turn mpv into an image viewer. Supports thumbnails via
[mpv-gallery-view](https://github.com/occivink/mpv-gallery-view).