Rename, Update Docs and Prepare for Release (#9)

Co-authored-by: Guilherme Rugai Freire <41879254+GRFreire@users.noreply.github.com>
Co-authored-by: N-R-K <79544946+N-R-K@users.noreply.github.com>
Co-authored-by: NRK <nrk@disroot.org>
Co-authored-by: Arthur Williams <taaparthur@gmail.com>
Co-authored-by: eylles <ed.ylles1997@gmail.com>

1 files changed, 51 insertions, 178 deletions

diff --git a/README.md b/README.md
index f2aba7a..2de6187 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,16 @@
-![sxiv](http://muennich.github.com/sxiv/img/logo.png "sxiv")
+![nsxiv](https://raw.githubusercontent.com/nsxiv/nsxiv/gh-pages/img/logo.png "nsxiv")
 
-**Simple X Image Viewer**
+**Neo (or New or Not) Simple (or Small or Suckless) X Image Viewer**
+--------------------------------------------------------------------
 
-The sole purpose of sxiv is to be the perfect image viewer for me. It is free
-software so that you can use it and modify it for your needs. Please file a bug
-report if something does not work as documented or expected. Contributions are
-welcome but there is no guarantee that they will be incorporated.
+nsxiv is a fork of now unmaintained [sxiv](https://github.com/muennich/sxiv)
+with the purpose of maintaining it 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 in *this* repository, after making sure you are using the latest
+release of nsxiv. Contributions are welcome, see [CONTRIBUTING.md](CONTRIBUTING.md)
+for details.
 
 
 Features
@@ -16,26 +21,27 @@ Features
 * Thumbnail mode: grid of selectable previews of all images
 * Ability to cache thumbnails for fast re-loading
 * Basic support for multi-frame images
-* Load all frames from GIF files and play GIF animations
+* Play GIF animations
 * Display image information in status bar
+* Display image name/path in X title
 
 
 Screenshots
 -----------
 
-**Image mode:**
+**Image mode: (Default colors)**
 
-![Image](http://muennich.github.com/sxiv/img/image.png "Image mode")
+![Image](https://raw.githubusercontent.com/nsxiv/nsxiv/gh-pages/img/image.png "Image mode")
 
-**Thumbnail mode:**
+**Thumbnail mode: (Custom colors)**
 
-![Thumb](http://muennich.github.com/sxiv/img/thumb.png "Thumb mode")
+![Thumb](https://raw.githubusercontent.com/nsxiv/nsxiv/gh-pages/img/thumb.png "Thumb mode")
 
 
 Dependencies
 ------------
 
-sxiv requires the following software to be installed:
+nsxiv requires the following software to be installed:
 
   * Imlib2
   * X11
@@ -46,37 +52,39 @@ sxiv requires the following software to be installed:
   * libexif (optional, automatically enabled if installed)
 
 Please make sure to install the corresponding development packages in case that
-you want to build sxiv on a distribution with separate runtime and development
-packages (e.g. *-dev on Debian).
+you want to build nsxiv on a distribution with separate runtime and development
+packages (e.g. \*-dev on Debian).
 
 
 Building
 --------
 
-sxiv is built using the commands:
+nsxiv is built using the commands:
 
     $ make
-    # make install
-
-Please note, that the latter one requires root privileges.
-By default, sxiv is installed using the prefix "/usr/local", so the full path
-of the executable will be "/usr/local/bin/sxiv".
 
 Running make will automatically detect if libexif and libgif are available and
 enable them if so. CLI arguments will override any automatic detection.
 For example:
 
-	$ make HAVE_LIBGIF=0
+    $ make HAVE_LIBGIF=0
 
 will always disable libgif.
 Alternatively, they can be disabled via editing `config.mk`.
 
-You can install sxiv into a directory of your choice by changing the second
-command to:
+Installing nsxiv:
+
+    # make install
+
+Please note, that this requires root privileges.
+By default, nsxiv is installed using the prefix "/usr/local", so the full path
+of the executable will be "/usr/local/bin/nsxiv".
+
+You can install nsxiv into a directory of your choice by changing this command to:
 
-    # make PREFIX="/your/dir" install
+    $ make PREFIX="/your/dir" install
 
-The build-time specific settings of sxiv can be found in the file *config.h*.
+The build-time specific settings of nsxiv can be found in the file *config.h*.
 Please check and change them, so that they fit your needs.
 If the file *config.h* does not already exist, then you have to create it with
 the following command:
@@ -87,167 +95,32 @@ the following command:
 Usage
 -----
 
-Please see the [man page](http://muennich.github.com/sxiv/sxiv.1.html) for
-information on how to use sxiv.
-
-
-Download & Changelog
---------------------
-
-You can [browse](https://github.com/muennich/sxiv) the source code repository
-on GitHub or get a copy using git with the following command:
-
-    git clone https://github.com/muennich/sxiv.git
-
-**Stable releases**
-
-**[v26](https://github.com/muennich/sxiv/archive/v26.tar.gz)**
-*(January 16, 2020)*
-
-  * Maintenance release
-
-**[v25](https://github.com/muennich/sxiv/archive/v25.tar.gz)**
-*(January 26, 2019)*
-
-  * Support font fallback for missing glyphs
-  * Fix busy loop when built without inotify
-  * Use background/foreground colors from X resource database
-
-**[v24](https://github.com/muennich/sxiv/archive/v24.tar.gz)**
-*(October 27, 2017)*
-
-  * Automatically reload the current image whenever it changes
-  * Support embedding into other X windows with -e (e.g. tabbed)
-  * New option -p prevents sxiv from creating cache and temporary files
-  * Simpler mouse mappings, the most basic features are accessible with the
-    mouse only (navigate, zoom, pan)
-
-**[v1.3.2](https://github.com/muennich/sxiv/archive/v1.3.2.tar.gz)**
-*(December 20, 2015)*
-
-  * external key handler gets file paths on stdin, not as arguments
-  * Cache out-of-view thumbnails in the background
-  * Apply gamma correction to thumbnails
-
-**[v1.3.1](https://github.com/muennich/sxiv/archive/v1.3.1.tar.gz)**
-*(November 16, 2014)*
-
-  * Fixed build error, caused by delayed config.h creation
-  * Fixed segfault when run with -c
-
-**[v1.3](https://github.com/muennich/sxiv/archive/v1.3.tar.gz)**
-*(October 24, 2014)*
-
-  * Extract thumbnails from EXIF tags (requires libexif)
-  * Zoomable thumbnails, supported sizes defined in config.h
-  * Fixed build error with giflib version >= 5.1.0
+Please see man page for information on how to use nsxiv. To do so, execute the
+following after the installation:
 
-**[v1.2](https://github.com/muennich/sxiv/archive/v1.2.tar.gz)**
-*(April 24, 2014)*
+    $ man nsxiv
 
-  * Added external key handler, called on keys prefixed with `Ctrl-x`
-  * New keybinding `{`/`}` to change gamma (by András Mohari)
-  * Support for slideshows, enabled with `-S` option & toggled with `s`
-  * Added application icon (created by 0ion9)
-  * Checkerboard background for alpha layer
-  * Option `-o` only prints files marked with `m` key
-  * Fixed rotation/flipping of multi-frame images (gifs)
 
-**[v1.1.1](https://github.com/muennich/sxiv/archive/v1.1.1.tar.gz)**
-*(June 2, 2013)*
-
-  * Various bug fixes
-
-**[v1.1](https://github.com/muennich/sxiv/archive/v1.1.tar.gz)**
-*(March 30, 2013)*
-
-  * Added status bar on bottom of window with customizable content
-  * New keyboard shortcuts `\`/`|`: flip image vertically/horizontally
-  * New keyboard shortcut `Ctrl-6`: go to last/alternate image
-  * Added own EXIF orientation handling, removed dependency on libexif
-  * Fixed various bugs
-
-**[v1.0](https://github.com/muennich/sxiv/archive/v1.0.tar.gz)**
-*(October 31, 2011)*
-
-  * Support for multi-frame images & GIF animations
-  * POSIX compliant (IEEE Std 1003.1-2001)
-
-**[v0.9](https://github.com/muennich/sxiv/archive/v0.9.tar.gz)**
-*(August 17, 2011)*
-
-  * Made key and mouse mappings fully configurable in config.h
-  * Complete code refactoring
-
-**[v0.8.2](https://github.com/muennich/sxiv/archive/v0.8.2.tar.gz)**
-*(June 29, 2011)*
-
-  * POSIX-compliant Makefile; compiles under NetBSD
-
-**[v0.8.1](https://github.com/muennich/sxiv/archive/v0.8.1.tar.gz)**
-*(May 8, 2011)*
-
-  * Fixed fullscreen under window managers, which are not fully EWMH-compliant
-
-**[v0.8](https://github.com/muennich/sxiv/archive/v0.8.tar.gz)**
-*(April 18, 2011)*
-
-  * Support for thumbnail caching
-  * Ability to run external commands (e.g. jpegtran, convert) on current image
-
-**[v0.7](https://github.com/muennich/sxiv/archive/v0.7.tar.gz)**
-*(February 26, 2011)*
-
-  * Sort directory entries when using `-r` command line option
-  * Hide cursor in image mode
-  * Full functional thumbnail mode, use Return key to switch between image and
-    thumbnail mode
-
-**[v0.6](https://github.com/muennich/sxiv/archive/v0.6.tar.gz)**
-*(February 16, 2011)*
-
-  * Bug fix: Correctly display filenames with umlauts in window title
-  * Basic support of thumbnails
-
-**[v0.5](https://github.com/muennich/sxiv/archive/v0.5.tar.gz)**
-*(February 6, 2011)*
-
-  * New command line option: `-r`: open all images in given directories
-  * New key shortcuts: `w`: resize image to fit into window; `W`: resize window
-    to fit to image
-
-**[v0.4](https://github.com/muennich/sxiv/archive/v0.4.tar.gz)**
-*(February 1, 2011)*
-
-  * New command line option: `-F`, `-g`: use fixed window dimensions and apply
-    a given window geometry
-  * New key shortcut: `r`: reload current image
-
-**[v0.3.1](https://github.com/muennich/sxiv/archive/v0.3.1.tar.gz)**
-*(January 30, 2011)*
+F.A.Q
+-----
 
-  * Bug fix: Do not set setuid bit on executable when using `make install`
-  * Pan image with mouse while pressing middle mouse button
+* Can I open remote urls with nsxiv? <br>
+Yes, see [nsxiv-url](https://github.com/nsxiv/nsxiv/wiki/nsxiv-url)
 
-**[v0.3](https://github.com/muennich/sxiv/archive/v0.3.tar.gz)**
-*(January 29, 2011)*
+* Can I open all the images in a directory? <br>
+Yes, see [nsxiv-rifle](https://github.com/nsxiv/nsxiv/wiki/nsxiv-rifle)
 
-  * New command line options: `-d`, `-f`, `-p`, `-s`, `-v`, `-w`, `-Z`, `-z`
-  * More mouse mappings: Go to next/previous image with left/right click,
-    scroll image with mouse wheel (horizontally if Shift key is pressed),
-    zoom image with mouse wheel if Ctrl key is pressed
+* Can I set default arguments for nsxiv? <br>
+Yes, see [nsxiv-env](https://github.com/nsxiv/nsxiv/wiki/nsxiv-env)
 
-**[v0.2](https://github.com/muennich/sxiv/archive/v0.2.tar.gz)**
-*(January 23, 2011)*
+* Can I pipe images into nsxiv? <br>
+No, not yet. See https://github.com/nsxiv/nsxiv/issues/32
 
-  * Bug fix: Handle window resizes correctly
-  * New keyboard shortcuts: `g`/`G`: go to first/last image; `[`/`]`: go 10
-    images back/forward
-  * Support for mouse wheel zooming (by Dave Reisner)
-  * Added fullscreen mode
 
-**[v0.1](https://github.com/muennich/sxiv/archive/v0.1.tar.gz)**
-*(January 21, 2011)*
+Download
+--------
 
-  * Initial release
+You can [browse](https://github.com/nsxiv/nsxiv) the source code repository
+on GitHub or get a copy using git with the following command:
 
+    $ git clone https://github.com/nsxiv/nsxiv.git