Convert README to markdown

This allows to display images and links a better way.

diff --git a/Makefile.am b/Makefile.am
index 610c55a..cd03ccd 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -8,7 +8,7 @@ DIST_SUBDIRS = src po doc plugins
 man_MANS = geeqie.1
 
 readmedir = @readmedir@
-readme_DATA = README COPYING ChangeLog TODO README.lirc
+readme_DATA = README.md COPYING ChangeLog TODO README.lirc
 
 desktopdir = $(datadir)/applications
 desktop_in_files = geeqie.desktop.in

diff --git a/README b/README.md
similarity index 89%
rename from README
rename to README.md
index 41933cf..8ea2448 100644 (file)
--- a/README
+++ b/README.md
@@ -12,6 +12,8 @@
 
 This is Geeqie, a successor of GQview.
 
+[![Build Status](https://api.travis-ci.org/BestImageViewer/geeqie.svg?branch=master)](https://travis-ci.org/BestImageViewer/geeqie)
+
 Geeqie has been forked from GQview project, because it was not possible to
 contact GQview author and the only maintainer. Geeqie projects goal is to move
 the development forward and also integrate the existing patches.
@@ -27,15 +29,15 @@ open an issue on Github (https://github.com/BestImageViewer/geeqie/issues)
 
 # README contents:
 
-    * Requirements
-    * Notes and changes for this release
-    * Installation
-    * Description / Features
-    * Documentation (keyboard shortcuts)
-    * Editor command macros
-    * Additional comments
-    * Translation status
-    * Credits
+* Requirements
+* Notes and changes for this release
+* Installation
+* Description / Features
+* Documentation (keyboard shortcuts)
+* Editor command macros
+* Additional comments
+* Translation status
+* Credits
 
 ## Requirements
 
@@ -118,31 +120,30 @@ See NEWS file.
 
 ## Installation
 
-  Compilation: ./autogen.sh ; make
-  Show compile options: ./autogen.sh --help
-  General install: make install
-  Removal: make uninstall
+Compilation: ./autogen.sh ; make
+Show compile options: ./autogen.sh --help
+General install: make install
+Removal: make uninstall
 
 ## Description / Features
 
-  Geeqie is a graphics file viewer. Basic features:
-
-    - Single click image viewing / navigation.
-    - Zoom functions.
-    - Thumbnails, with optional caching and .xvpics support.
-    - Multiple file selection for move, copy, delete, rename, drag and drop.
-    - Drag and drop.
-    - Slideshow.
-    - Full screen.
-    - Ability to open images in external editors (configurable).
-    - Collections.
-    - Comparison of images to find duplicates by name, size, date,
-      dimensions, or image content similarity.
-      - Rotation invariant detection
-    - EXIF support.
-    - support for stereoscopic images
-      - input: side-by-side (JPS) and MPO format
-      - output: single image, anaglyph, SBS, mirror, SBS half size (3DTV)
+Geeqie is a graphics file viewer. Basic features:
+
+* Single click image viewing / navigation.
+* Zoom functions.
+* Thumbnails, with optional caching and .xvpics support.
+* Multiple file selection for move, copy, delete, rename, drag and drop.
+* Drag and drop.
+* Slideshow.
+* Full screen.
+* Ability to open images in external editors (configurable).
+* Collections.
+* Comparison of images to find duplicates by name, size, date, dimensions, or image content similarity.
+    * Rotation invariant detection
+* EXIF support.
+* support for stereoscopic images
+    * input: side-by-side (JPS) and MPO format
+    * output: single image, anaglyph, SBS, mirror, SBS half size (3DTV)
 
 ## Credits                                             [section:credits]
 

diff --git a/geeqie.spec.in b/geeqie.spec.in
index c79f47a..2393d2f 100644 (file)
--- a/geeqie.spec.in
+++ b/geeqie.spec.in
@@ -81,7 +81,7 @@ make install DESTDIR=%{buildroot}
 %suse_update_desktop_file -n geeqie
 %endif
 
-%__install -m 644 AUTHORS COPYING ChangeLog NEWS README README.lirc "%{buildroot}/%{_docdir}/%{docname}/"
+%__install -m 644 AUTHORS COPYING ChangeLog NEWS README.md README.lirc "%{buildroot}/%{_docdir}/%{docname}/"
 
 %clean
 %__rm -rf "%{buildroot}"

diff --git a/src/window.c b/src/window.c
index 45782d6..6ccd2ad 100644 (file)
--- a/src/window.c
+++ b/src/window.c
@@ -257,7 +257,7 @@ void help_window_show(const gchar *key)
                return;
                }
 
-       path = g_build_filename(GQ_HELPDIR, "README", NULL);
+       path = g_build_filename(GQ_HELPDIR, "README.md", NULL);
        help_window = help_window_new(_("Help"), "help", path, key);
        g_free(path);