summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Friesel <derf@derf.homelinux.org>2010-06-17 14:39:45 +0200
committerDaniel Friesel <derf@derf.homelinux.org>2010-06-17 14:39:45 +0200
commit240c0df192ab421f6e73503b6e4eec4125f8891f (patch)
treea96caa085440688cd52ab2c2d76d0b7002cba280
parentfec1ed90f4d75ca0eb1900497fe7e76e7fcb3cec (diff)
Restructure README
-rw-r--r--README53
1 files changed, 37 insertions, 16 deletions
diff --git a/README b/README
index f1d0d88..cb05b6d 100644
--- a/README
+++ b/README
@@ -1,4 +1,24 @@
-Compile:
+feh - Imlib2 based image viewer
+
+ * <https://derf.homelinux.org/p/feh/>
+ * <http://linuxbrit.co.uk/feh/>
+
+
+Dependencies:
+
+ * giblib
+ * Imlib2
+ * libpng
+ * libX11
+
+
+Recommended:
+
+ * jpegtran (supplied by the jpeg library, for lossless image rotation)
+ * wget (for http/ftp support)
+
+
+Installation:
$ make
$ sudo make install
@@ -11,22 +31,23 @@ variables instead of editing it. E.g.:
CFLAGS='-g -Os' make
export DESTDIR=/tmp/feh PREFIX=/usr; make && make install
-If you want to run a few non-interactive tests, use "make test". This will
-require a standard perl distribution (especially the "prove" script) and the
-Test::Command module. If mdocml is installed, it will be used to check the
-manual syntax, otherwise that test will be skipped.
-What is feh?
+Testing (non-X):
-https://derf.homelinux.org/p/feh/
-http://linuxbrit.co.uk/feh/
+$ make test
-Dependencies:
- * giblib
- * Imlib2
- * libpng
- * libX11
+Requires perl >= 5.10 with Test::Command. The tests are non-interactive and
+work without X, so they can safely be run even on a headless buildserver.
-Recommends:
- * jpegtran (supplied by the jpeg library, for lossless image rotation)
- * wget (for http/ftp support)
+
+Testing (X):
+
+Requires
+ * perl >= 5.10
+ * X11::GUITest
+ * Xnest
+
+$ make test-interactive
+
+Be aware that this is quite experimental, so far the X-tests have only been
+run on one machine. So they may or may not work for you.