nsxiv4ef2062
readme.md
+0 −94
1 file changed
- M README.md +0 −94
| @@ -1,68 +1,3 @@ | |||
| 1 | − | [](https://codeberg.org/nsxiv/nsxiv) | |
| 2 | − | ||
| 3 | − | [](https://codeberg.org/nsxiv/nsxiv) | |
| 4 | − | [](https://codeberg.org/nsxiv/nsxiv/tags) | |
| 5 | − | [](https://codeberg.org/nsxiv/nsxiv/src/branch/master/LICENSE) | |
| 6 | − | [](https://codeberg.org/nsxiv/nsxiv) | |
| 7 | − | ||
| 8 | − | **Neo (or New or Not) Simple (or Small or Suckless) X Image Viewer** | |
| 9 | − | -------------------------------------------------------------------- | |
| 10 | − | ||
| 11 | − | nsxiv is a fork of the now-unmaintained [sxiv](https://github.com/xyb3rt/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. | |
| 15 | − | ||
| 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] to get started. | |
| 19 | − | ||
| 20 | − | [Codeberg]: https://codeberg.org/nsxiv/nsxiv/issues/new | |
| 21 | − | [CONTRIBUTING]: etc/CONTRIBUTING.md#contribution-guideline | |
| 22 | − | ||
| 23 | − | ||
| 24 | − | Features | |
| 25 | − | -------- | |
| 26 | − | ||
| 27 | − | * Basic image operations like zooming, panning, rotating | |
| 28 | − | * Basic support for animated/multi-frame images | |
| 29 | − | * Thumbnail mode: grid of selectable previews of all images | |
| 30 | − | * Ability to cache thumbnails for fast re-loading | |
| 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` | |
| 36 | − | ||
| 37 | − | ||
| 38 | − | Screenshots | |
| 39 | − | ----------- | |
| 40 | − | ||
| 41 | − | **Image mode with default colors:** | |
| 42 | − | ||
| 43 | − |  | |
| 44 | − | ||
| 45 | − | **Thumbnail mode with custom colors:** | |
| 46 | − | ||
| 47 | − |  | |
| 48 | − | ||
| 49 | − | ||
| 50 | − | Installing via package manager | |
| 51 | − | ------------------------------ | |
| 52 | − | ||
| 53 | − | <a href="https://repology.org/project/nsxiv/versions"> | |
| 54 | − | <img align="right" width="192" src="https://repology.org/badge/vertical-allrepos/nsxiv.svg"> | |
| 55 | − | </a> | |
| 56 | − | ||
| 57 | − | nsxiv is available on the following distributions/repositories. If you don't see | |
| 58 | − | your distro listed here, either contact your distro's package maintainer or | |
| 59 | − | consider packaging it yourself and adding it to the respective community repo. | |
| 60 | − | ||
| 61 | − | Repos not tracked by repology: | |
| 62 | − | ||
| 63 | − | * Fedora: Enable the copr repo via `dnf copr enable mamg22/nsxiv`. | |
| 64 | − | ||
| 65 | − | ||
| 66 | 1 | Dependencies | |
| 67 | 2 | ------------ | |
| 68 | 3 | ||
| @@ -200,32 +135,3 @@ merge it to mainline. | |||
| 200 | 135 | ||
| 201 | 136 | Description on how to use or submit patches can be found on | |
| 202 | 137 | nsxiv-extra's [README](https://codeberg.org/nsxiv/nsxiv-extra). | |
| 203 | − | ||
| 204 | − | ||
| 205 | − | Download | |
| 206 | − | -------- | |
| 207 | − | ||
| 208 | − | You can [browse](https://codeberg.org/nsxiv/nsxiv) the source code repository | |
| 209 | − | on CodeBerg or get a copy using git with the following command: | |
| 210 | − | ||
| 211 | − | $ git clone https://codeberg.org/nsxiv/nsxiv.git | |
| 212 | − | ||
| 213 | − | You can view the changelog [here](etc/CHANGELOG.md) | |
| 214 | − | ||
| 215 | − | ||
| 216 | − | Similar projects | |
| 217 | − | ---------------- | |
| 218 | − | ||
| 219 | − | If nsxiv isn't able to fit your needs, check out the image viewer section of | |
| 220 | − | **[suckless rocks](https://suckless.org/rocks)** to find other minimal image | |
| 221 | − | viewers to try out. | |
| 222 | − | ||
| 223 | − | Below are a couple other lesser known projects not listed in suckless rocks. | |
| 224 | − | ||
| 225 | − | * [MAGE](https://codeberg.org/explosion-mental/mage): | |
| 226 | − | A smaller/more-suckless version of sxiv. | |
| 227 | − | * [div](https://codeberg.org/TAAPArthur/div): | |
| 228 | − | Minimal and extensive, aimed at C devs willing to build their own features. | |
| 229 | − | * [mpv-image-viewer](https://github.com/occivink/mpv-image-viewer): | |
| 230 | − | Lua script to turn mpv into an image viewer. Supports thumbnails via | |
| 231 | − | [mpv-gallery-view](https://github.com/occivink/mpv-gallery-view). | |