From 7d87e6e412badab61fe67b9a00ca686195631e05 Mon Sep 17 00:00:00 2001 From: N-R-K <79544946+N-R-K@users.noreply.github.com> Date: Tue, 23 Nov 2021 13:27:14 +0600 Subject: [PATCH] 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 --- CONTRIBUTING.md | 3 --- README.md | 21 +++++++++++++++++++-- 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2406167..4fd5ebb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,3 @@ -Contribution Guideline ----------------------- - Project Scope ------------- diff --git a/README.md b/README.md index 5048b66..18b1179 100644 --- a/README.md +++ b/README.md @@ -22,10 +22,10 @@ Features * Basic image operations, e.g. zooming, panning, rotating * Customizable key and mouse button mappings (in *config.h*) +* Script-ability via `key-handler` * Thumbnail mode: grid of selectable previews of all images * Ability to cache thumbnails for fast re-loading -* Basic support for multi-frame images -* Play GIF animations +* Basic support for animated/multi-frame images (GIF/WebP) * Display image information in status bar * 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 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).