readme.md
This commit is contained in:
parent
c280021253
commit
4ef20627a7
94
README.md
94
README.md
|
|
@ -1,68 +1,3 @@
|
|||
[](https://codeberg.org/nsxiv/nsxiv)
|
||||
|
||||
[](https://codeberg.org/nsxiv/nsxiv)
|
||||
[](https://codeberg.org/nsxiv/nsxiv/tags)
|
||||
[](https://codeberg.org/nsxiv/nsxiv/src/branch/master/LICENSE)
|
||||
[](https://codeberg.org/nsxiv/nsxiv)
|
||||
|
||||
**Neo (or New or Not) Simple (or Small or Suckless) X Image Viewer**
|
||||
--------------------------------------------------------------------
|
||||
|
||||
nsxiv is a fork of the now-unmaintained [sxiv](https://github.com/xyb3rt/sxiv)
|
||||
with the purpose of being a (mostly) drop-in replacement for sxiv, maintaining its
|
||||
interface and adding simple, sensible features. nsxiv is free software licensed
|
||||
under GPLv2 and aims to be easy to modify and customize.
|
||||
|
||||
Please file a bug report if something does not work as documented or expected on
|
||||
[Codeberg] after making sure you are using the latest release. Contributions
|
||||
are welcome, see [CONTRIBUTING] to get started.
|
||||
|
||||
[Codeberg]: https://codeberg.org/nsxiv/nsxiv/issues/new
|
||||
[CONTRIBUTING]: etc/CONTRIBUTING.md#contribution-guideline
|
||||
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
* Basic image operations like zooming, panning, rotating
|
||||
* Basic support for animated/multi-frame images
|
||||
* Thumbnail mode: grid of selectable previews of all images
|
||||
* Ability to cache thumbnails for fast re-loading
|
||||
* Automatically refreshing modified images
|
||||
* Customizable keyboard and mouse mappings via `config.h`
|
||||
* Scriptability via `key-handler`
|
||||
* Displaying image information in status bar via `image-info` & `thumb-info`
|
||||
* Customizable window title via `win-title`
|
||||
|
||||
|
||||
Screenshots
|
||||
-----------
|
||||
|
||||
**Image mode with default colors:**
|
||||
|
||||

|
||||
|
||||
**Thumbnail mode with custom colors:**
|
||||
|
||||

|
||||
|
||||
|
||||
Installing via package manager
|
||||
------------------------------
|
||||
|
||||
<a href="https://repology.org/project/nsxiv/versions">
|
||||
<img align="right" width="192" src="https://repology.org/badge/vertical-allrepos/nsxiv.svg">
|
||||
</a>
|
||||
|
||||
nsxiv is available on the following distributions/repositories. If you don't see
|
||||
your distro listed here, either contact your distro's package maintainer or
|
||||
consider packaging it yourself and adding it to the respective community repo.
|
||||
|
||||
Repos not tracked by repology:
|
||||
|
||||
* Fedora: Enable the copr repo via `dnf copr enable mamg22/nsxiv`.
|
||||
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
|
||||
|
|
@ -200,32 +135,3 @@ merge it to mainline.
|
|||
|
||||
Description on how to use or submit patches can be found on
|
||||
nsxiv-extra's [README](https://codeberg.org/nsxiv/nsxiv-extra).
|
||||
|
||||
|
||||
Download
|
||||
--------
|
||||
|
||||
You can [browse](https://codeberg.org/nsxiv/nsxiv) the source code repository
|
||||
on CodeBerg or get a copy using git with the following command:
|
||||
|
||||
$ git clone https://codeberg.org/nsxiv/nsxiv.git
|
||||
|
||||
You can view the changelog [here](etc/CHANGELOG.md)
|
||||
|
||||
|
||||
Similar 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://codeberg.org/explosion-mental/mage):
|
||||
A smaller/more-suckless version of sxiv.
|
||||
* [div](https://codeberg.org/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).
|
||||
|
|
|
|||
Loading…
Reference in New Issue