Krolyxon
Commit b39f34a

Branches

Refs →

nsxivb39f34a

Added Download/Changelog section to README

Author
Bert Münnich
Date
2012-12-21 23:36 +0100
Parent
5106472
Commit
b39f34a131a69b2a7735046653e009bc97aea084

+116 −11

1 file changed

Browse files Patch
−Context 3+
  1. M README.md +116 −11
M README.md View
@@ -1,4 +1,7 @@
1−sxiv: Simple (or small or suckless) X Image Viewer
1+sxiv
2+====
3+
4+**Simple (or small or suckless) X Image Viewer**
25
36 sxiv is an alternative to feh and qiv. Its only dependencies besides xlib are
47 imlib2 and giflib. The primary goal for writing sxiv is to create an image
@@ -7,6 +10,7 @@ viewer, which only has the most basic features required for fast image viewing
710 managers. Its code base should be kept small and clean to make it easy for you
811 to dig into it and customize it for your needs.
912
13+
1014 Features
1115 --------
1216
@@ -18,19 +22,22 @@ Features
1822 * Load all frames from GIF files and play GIF animations
1923 * Display image information in window title
2024
25+
2126 Screenshots
2227 -----------
2328
24−Image mode:
29+**Image mode:**
2530
26− <img src="http://github.com/muennich/sxiv/raw/master/sample/image.png">
31+![Image](http://muennich.github.com/sxiv/img/image.png "Image mode")
2732
28−Thumbnail mode:
33+**Thumbnail mode:**
34+
35+![Thumb](http://muennich.github.com/sxiv/img/thumb.png "Thumb mode")
2936
30− <img src="http://github.com/muennich/sxiv/raw/master/sample/thumb.png">
3137
3238 Installation
3339 ------------
40+
3441 sxiv is built using the commands:
3542
3643 $ make
@@ -52,13 +59,14 @@ the following command:
5259
5360 $ make config.h
5461
62+
5563 Usage
5664 -----
5765 sxiv has two modes of operation: image and thumbnail mode. The default is
5866 image mode, in which only the current image is shown. In thumbnail mode a grid
5967 of small previews is displayed, making it easy to choose an image to open.
6068
61−sxiv supports the following command-line options:
69+**Command line options:**
6270
6371 -b Do not show info bar on bottom of window
6472 -c Remove all orphaned cache files from thumbnail cache and exit
@@ -78,7 +86,7 @@ sxiv supports the following command-line options:
7886 -Z Same as `-z 100'
7987 -z ZOOM Scale all images to current zoom level, use ZOOM at startup
8088
81−The following general key commands are available:
89+**Key mappings:**
8290
8391 q Quit sxiv
8492 Return Switch to thumbnail mode / open selected image
@@ -97,13 +105,12 @@ The following general key commands are available:
97105 R Reload all thumbnails
98106 D Remove image from file list and go to next image
99107
100−
101−The following additional key commands are available in *thumbnail mode*:
108+*Thumbnail mode:*
102109
103110 h,j,k,l Move selection left/down/up/right [count] times
104111 Ctrl-j,k Scroll thumbnail grid one window height down/up
105112
106−The following additional key commands are available in *image mode*:
113+*Image mode:*
107114
108115 n,Space Go [count] images forward
109116 p,Backspace Go [count] images backward
@@ -131,7 +138,9 @@ The following additional key commands are available in *image mode*:
131138 a Toggle anti-aliasing
132139 W Resize window to fit image
133140
134−Additionally, the following mouse commands are available in *image mode*:
141+**Mouse button mappings:**
142+
143+*Image mode:*
135144
136145 Button1 Go to the next image
137146 Button2 Drag image with mouse while keeping it pressed
@@ -139,3 +148,99 @@ Additionally, the following mouse commands are available in *image mode*:
139148 Scroll Pan image up/down
140149 Shift+Scroll Pan image left/right
141150 Ctrl+Scroll Zoom in/out
151+
152+
153+Download & Changelog
154+--------------------
155+
156+You can [browse](https://github.com/muennich/sxiv) the source code repository
157+on GitHub or get a copy using git with the following command:
158+
159+ git clone https://github.com/muennich/sxiv.git
160+
161+**Stable releases**
162+
163+**[v1.0](http://muennich.github.com/sxiv/release/sxiv-1.0.tar.gz)**
164+*(October 31, 2011)*
165+
166+ * Support for multi-frame images & GIF animations
167+ * POSIX compliant (IEEE Std 1003.1-2001)
168+
169+**[v0.9](http://muennich.github.com/sxiv/release/sxiv-0.9.tar.gz)**
170+*(August 17, 2011)*
171+
172+ * Made key and mouse mappings fully configurable in config.h
173+ * Complete code refactoring
174+
175+**[v0.8.2](http://muennich.github.com/sxiv/release/sxiv-0.8.2.tar.gz)**
176+*(June 29, 2011)*
177+
178+ * POSIX-compliant Makefile; compiles under NetBSD
179+
180+**[v0.8.1](http://muennich.github.com/sxiv/release/sxiv-0.8.1.tar.gz)**
181+*(May 8, 2011)*
182+
183+ * Fixed fullscreen under window managers, which are not fully EWMH-compliant
184+
185+**[v0.8](http://muennich.github.com/sxiv/release/sxiv-0.8.tar.gz)**
186+*(April 18, 2011)*
187+
188+ * Support for thumbnail caching, only enabled if directory `~/.sxiv/` exists
189+ * Ability to run external commands (e.g. jpegtran, convert) on current image
190+
191+**[v0.7](http://muennich.github.com/sxiv/release/sxiv-0.7.tar.gz)**
192+*(February 26, 2011)*
193+
194+ * Sort directory entries when using `-r` command line option
195+ * Hide cursor in image mode
196+ * Full functional thumbnail mode, use Return key to switch between image and
197+ thumbnail mode
198+
199+**[v0.6](http://muennich.github.com/sxiv/release/sxiv-0.6.tar.gz)**
200+*(February 16, 2011)*
201+
202+ * Bug fix: Correctly display filenames with umlauts in window title
203+ * Basic support of thumbnails
204+
205+**[v0.5](http://muennich.github.com/sxiv/release/sxiv-0.5.tar.gz)**
206+*(February 6, 2011)*
207+
208+ * New command line option: `-r`: open all images in given directories
209+ * New key shortcuts: `w`: resize image to fit into window; `W`: resize window
210+ to fit to image
211+
212+**[v0.4](http://muennich.github.com/sxiv/release/sxiv-0.4.tar.gz)**
213+*(February 1, 2011)*
214+
215+ * New command line option: `-F`, `-g`: use fixed window dimensions and apply
216+ a given window geometry
217+ * New key shortcut: `r`: reload current image
218+
219+**[v0.3.1](http://muennich.github.com/sxiv/release/sxiv-0.3.1.tar.gz)**
220+*(January 30, 2011)*
221+
222+ * Bug fix: Do not set setuid bit on executable when using `make install`
223+ * Pan image with mouse while pressing middle mouse button
224+
225+**[v0.3](http://muennich.github.com/sxiv/release/sxiv-0.3.tar.gz)**
226+*(January 29, 2011)*
227+
228+ * New command line options: `-d`, `-f`, `-p`, `-s`, `-v`, `-w`, `-Z`, `-z`
229+ * More mouse mappings: Go to next/previous image with left/right click,
230+ scroll image with mouse wheel (horizontally if Shift key is pressed),
231+ zoom image with mouse wheel if Ctrl key is pressed
232+
233+**[v0.2](http://muennich.github.com/sxiv/release/sxiv-0.2.tar.gz)**
234+*(January 23, 2011)*
235+
236+ * Bug fix: Handle window resizes correctly
237+ * New keyboard shortcuts: `g`/`G`: go to first/last image; `[`/`]`: go 10
238+ images back/forward
239+ * Support for mouse wheel zooming (by Dave Reisner)
240+ * Added fullscreen mode
241+
242+**[v0.1](http://muennich.github.com/sxiv/release/sxiv-0.1.tar.gz)**
243+*(January 21, 2011)*
244+
245+ * Initial release
246+