Krolyxon
Commit 5c2c719

Branches

Refs →

nsxiv5c2c719

Clean up readme (#330)

Author
Berke Kocaoğlu
Date
2022-06-29 01:02 +0200
Parent
b162aee
Commit
5c2c719735f391746dd759c00b703ca540f700b1

+42 −32

1 file changed

Browse files Patch
−Context 3+
  1. M README.md +42 −32
M README.md View
@@ -8,38 +8,41 @@
88 **Neo (or New or Not) Simple (or Small or Suckless) X Image Viewer**
99 --------------------------------------------------------------------
1010
11−nsxiv is a fork of now unmaintained [sxiv](https://github.com/muennich/sxiv)
12−with the purpose of being a drop-in replacement of sxiv, maintaining it and
13−adding simple, sensible features. nsxiv is free software licensed under GPLv2
14−and aims to be easy to modify and customize.
11+nsxiv is a fork of the now-unmaintained [sxiv](https://github.com/muennich/sxiv)
12+with the purpose of being a (mostly) drop-in replacement for sxiv, maintaining its
13+interface and adding simple, sensible features. nsxiv is free software licensed
14+under GPLv2 and aims to be easy to modify and customize.
1515
16−Please file a bug report if something does not work as documented or
17−expected in *this* repository, after making sure you are using the latest
18−release of nsxiv. Contributions are welcome, see
19−[CONTRIBUTING.md](CONTRIBUTING.md#contribution-guideline) for details.
16+Please file a bug report if something does not work as documented or expected on
17+[Codeberg] after making sure you are using the latest release. Contributions
18+are welcome, see [CONTRIBUTING.md] to get started.
19+
20+[Codeberg]: https://codeberg.org/nsxiv/nsxiv/issues/new
21+[CONTRIBUTING.md]: CONTRIBUTING.md#contribution-guideline
2022
2123
2224 Features
2325 --------
2426
25−* Basic image operations, e.g. zooming, panning, rotating
26−* Customizable key and mouse button mappings (in *config.h*)
27−* Script-ability via `key-handler`
27+* Basic image operations like zooming, panning, rotating
28+* Basic support for animated/multi-frame images
2829 * Thumbnail mode: grid of selectable previews of all images
2930 * Ability to cache thumbnails for fast re-loading
30−* Basic support for animated/multi-frame images (GIF/WebP)
31−* Display image information in status bar
32−* Customizable window title
31+* Automatically refreshing modified images
32+* Customizable keyboard and mouse mappings via `config.h`
33+* Scriptability via `key-handler`
34+* Displaying image information in status bar via `image-info` & `thumb-info`
35+* Customizable window title via `win-title`
3336
3437
3538 Screenshots
3639 -----------
3740
38−**Image mode: (Default colors)**
41+**Image mode with default colors:**
3942
4043 ![Image](https://codeberg.org/nsxiv/pages/raw/branch/master/img/image.png "Image mode")
4144
42−**Thumbnail mode: (Custom colors)**
45+**Thumbnail mode with custom colors:**
4346
4447 ![Thumb](https://codeberg.org/nsxiv/pages/raw/branch/master/img/thumb.png "Thumb mode")
4548
@@ -70,22 +73,29 @@ nsxiv requires the following software to be installed:
7073
7174 The following dependencies are optional.
7275
73− * inotify : Used for auto-reloading images on change.
74− Disabled via `HAVE_INOTIFY=0`
75− * libXft, freetype2, fontconfig : Used for the status bar.
76− Disabled via `HAVE_LIBFONTS=0`
77− * giflib : Used for animated gif playback.
76+ * `inotify`<sup>ℹ</sup>: Used for auto-reloading images on change.
77+ Disabled via `HAVE_INOTIFY=0`.
78+ * `libXft`, `freetype2`, `fontconfig`: Used for the status bar.
79+ Disabled via `HAVE_LIBFONTS=0`.
80+ * `giflib`: Used for animated gif playback.
7881 Disabled via `HAVE_LIBGIF=0`.
79− * libexif : Used for auto-orientation and exif thumbnails.
80− Disable via `HAVE_LIBEXIF=0`
81− * libwebp : Used for animated webp playback.
82− (NOTE: animated webp also requires Imlib2 v1.7.5 or above)
82+ * `libexif`: Used for auto-orientation and exif thumbnails.
83+ Disable via `HAVE_LIBEXIF=0`.
84+ * `libwebp`: Used for animated webp playback.
85+ (***NOTE***: animated webp also requires Imlib2 v1.7.5 or above)
8386 Disabled via `HAVE_LIBWEBP=0`.
8487
8588 Please make sure to install the corresponding development packages in case that
8689 you want to build nsxiv on a distribution with separate runtime and development
8790 packages (e.g. \*-dev on Debian).
8891
92+\[ℹ]: [inotify][] is a Linux-specific API for monitoring filesystem changes.
93+ It's not natively available on `*BSD` systems but can be enabed via installing
94+ and linking against [libinotify-kqueue][].
95+
96+[inotify]: https://www.man7.org/linux/man-pages/man7/inotify.7.html
97+[libinotify-kqueue]: https://github.com/libinotify-kqueue/libinotify-kqueue
98+
8999
90100 Building
91101 --------
@@ -144,14 +154,13 @@ the following command:
144154 Usage
145155 -----
146156
147−Please see man page for information on how to use nsxiv. To do so, execute the
148−following after the installation:
157+Refer to the man page for the documentation:
149158
150159 $ man nsxiv
151160
152161
153−F.A.Q
154−-----
162+F.A.Q.
163+------
155164
156165 * Can I open remote urls with nsxiv? <br>
157166 Yes, see [nsxiv-url](https://codeberg.org/nsxiv/nsxiv-extra/src/branch/master/scripts/nsxiv-url)
@@ -199,6 +208,7 @@ on CodeBerg or get a copy using git with the following command:
199208
200209 You can view the changelog [here](CHANGELOG.md)
201210
211+
202212 Similar projects
203213 ----------------
204214
@@ -208,10 +218,10 @@ viewers to try out.
208218
209219 Below are a couple other lesser known projects not listed in suckless rocks.
210220
211−* [MAGE](https://github.com/explosion-mental/mage) :
221+* [MAGE](https://github.com/explosion-mental/mage):
212222 A smaller/more-suckless version of sxiv.
213−* [div](https://github.com/TAAPArthur/div) :
223+* [div](https://github.com/TAAPArthur/div):
214224 Minimal and extensive, aimed at C devs willing to build their own features.
215−* [mpv-image-viewer](https://github.com/occivink/mpv-image-viewer) :
225+* [mpv-image-viewer](https://github.com/occivink/mpv-image-viewer):
216226 Lua script to turn mpv into an image viewer. Supports thumbnails via
217227 [mpv-gallery-view](https://github.com/occivink/mpv-gallery-view).