Alexander/nsxiv
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clean up readme (#330)

Browse Source 
Co-authored-by: NRK <nrk@disroot.org>
Reviewed-on: https://codeberg.org/nsxiv/nsxiv/pulls/330
Reviewed-by: NRK <nrk@disroot.org>
This commit is contained in:
Berke Kocaoğlu 2022-06-29 01:02:17 +02:00
parent b162aee497
commit 5c2c719735
1 changed files with 42 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
README.md
View File

@ -8,38 +8,41 @@
**Neo (or New or Not) Simple (or Small or Suckless) X Image Viewer** **Neo (or New or Not) Simple (or Small or Suckless) X Image Viewer**
-------------------------------------------------------------------- --------------------------------------------------------------------
nsxiv is a fork of now unmaintained [sxiv](https://github.com/muennich/sxiv) nsxiv is a fork of the now-unmaintained [sxiv](https://github.com/muennich/sxiv)
with the purpose of being a drop-in replacement of sxiv, maintaining it and with the purpose of being a (mostly) drop-in replacement for sxiv, maintaining its
adding simple, sensible features. nsxiv is free software licensed under GPLv2 interface and adding simple, sensible features. nsxiv is free software licensed
and aims to be easy to modify and customize. under GPLv2 and aims to be easy to modify and customize.
Please file a bug report if something does not work as documented or Please file a bug report if something does not work as documented or expected on
expected in *this* repository, after making sure you are using the latest [Codeberg] after making sure you are using the latest release. Contributions
release of nsxiv. Contributions are welcome, see are welcome, see [CONTRIBUTING.md] to get started.
[CONTRIBUTING.md](CONTRIBUTING.md#contribution-guideline) for details.
[Codeberg]: https://codeberg.org/nsxiv/nsxiv/issues/new
[CONTRIBUTING.md]: CONTRIBUTING.md#contribution-guideline
Features Features
-------- --------
* Basic image operations, e.g. zooming, panning, rotating * Basic image operations like zooming, panning, rotating
* Customizable key and mouse button mappings (in *config.h*) * Basic support for animated/multi-frame images
* 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 animated/multi-frame images (GIF/WebP) * Automatically refreshing modified images
* Display image information in status bar * Customizable keyboard and mouse mappings via `config.h`
* Customizable window title * Scriptability via `key-handler`
* Displaying image information in status bar via `image-info` & `thumb-info`
* Customizable window title via `win-title`
Screenshots Screenshots
----------- -----------
**Image mode: (Default colors)** **Image mode with default colors:**
![Image](https://codeberg.org/nsxiv/pages/raw/branch/master/img/image.png "Image mode") ![Image](https://codeberg.org/nsxiv/pages/raw/branch/master/img/image.png "Image mode")
**Thumbnail mode: (Custom colors)** **Thumbnail mode with custom colors:**
![Thumb](https://codeberg.org/nsxiv/pages/raw/branch/master/img/thumb.png "Thumb mode") ![Thumb](https://codeberg.org/nsxiv/pages/raw/branch/master/img/thumb.png "Thumb mode")
@ -70,22 +73,29 @@ nsxiv requires the following software to be installed:
The following dependencies are optional. The following dependencies are optional.
* inotify : Used for auto-reloading images on change. * `inotify`<sup>ℹ</sup>: Used for auto-reloading images on change.
Disabled via `HAVE_INOTIFY=0` Disabled via `HAVE_INOTIFY=0`.
* libXft, freetype2, fontconfig : Used for the status bar. * `libXft`, `freetype2`, `fontconfig`: Used for the status bar.
Disabled via `HAVE_LIBFONTS=0` Disabled via `HAVE_LIBFONTS=0`.
* giflib : Used for animated gif playback. * `giflib`: Used for animated gif playback.
Disabled via `HAVE_LIBGIF=0`. Disabled via `HAVE_LIBGIF=0`.
* libexif : Used for auto-orientation and exif thumbnails. * `libexif`: Used for auto-orientation and exif thumbnails.
Disable via `HAVE_LIBEXIF=0` Disable via `HAVE_LIBEXIF=0`.
* libwebp : Used for animated webp playback. * `libwebp`: Used for animated webp playback.
(NOTE: animated webp also requires Imlib2 v1.7.5 or above) (***NOTE***: animated webp also requires Imlib2 v1.7.5 or above)
Disabled via `HAVE_LIBWEBP=0`. Disabled via `HAVE_LIBWEBP=0`.
Please make sure to install the corresponding development packages in case that Please make sure to install the corresponding development packages in case that
you want to build nsxiv on a distribution with separate runtime and development you want to build nsxiv on a distribution with separate runtime and development
packages (e.g. \*-dev on Debian). packages (e.g. \*-dev on Debian).
\[ℹ]: [inotify][] is a Linux-specific API for monitoring filesystem changes.
It's not natively available on `*BSD` systems but can be enabed via installing
and linking against [libinotify-kqueue][].
[inotify]: https://www.man7.org/linux/man-pages/man7/inotify.7.html
[libinotify-kqueue]: https://github.com/libinotify-kqueue/libinotify-kqueue
Building Building
-------- --------
@ -144,14 +154,13 @@ the following command:
Usage Usage
----- -----
Please see man page for information on how to use nsxiv. To do so, execute the Refer to the man page for the documentation:
following after the installation:
$ man nsxiv $ man nsxiv
F.A.Q F.A.Q.
----- ------
* Can I open remote urls with nsxiv? <br> * Can I open remote urls with nsxiv? <br>
Yes, see [nsxiv-url](https://codeberg.org/nsxiv/nsxiv-extra/src/branch/master/scripts/nsxiv-url) 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:
You can view the changelog [here](CHANGELOG.md) You can view the changelog [here](CHANGELOG.md)
Similar projects Similar projects
---------------- ----------------