switch README to markdown syntax

1 files changed, 36 insertions, 67 deletions

diff --git a/README b/README
index 1c02e0f..91fde2e 100644
--- a/README
+++ b/README
@@ -1,7 +1,5 @@
-======
-gipfel
-======
-
+Description
+===========
 gipfel helps to find the names of mountains or points of interest
 on a picture.
 It uses a database containing names and GPS data. With the given viewpoint
@@ -12,28 +10,24 @@ gipfel can also be used to play around with the parameters manually. But be
 warned: It is pretty difficult to find the right parameters for a given
 picture manually.
 
-
 Requirements
 ============
-- fltk-1.1.x (http://www.fltk.org)
-- libtiff (http://www.remotesensing.org/libtiff/)
-- libjpeg (http://www.ijg.org/)
-- exif utility (http://libexif.sourceforge.net/)
-- GSL - GNU Scientific Library (http://www.gnu.org/software/gsl/)
-- gipfel works on UNIX-like system (e.g. Linux, *BSD and probably others)
-
+* fltk-1.1.x <http://www.fltk.org>
+* libtiff <http://www.remotesensing.org/libtiff/>
+* libjpeg <http://www.ijg.org/>
+* exif utility <http://libexif.sourceforge.net/>
+* GSL - GNU Scientific Library <http://www.gnu.org/software/gsl/>
+* gipfel works on UNIX-like systems (e.g. Linux, *BSD and probably others)
 
 Installation
 ============
-- Unpack the tar file and run ./configure; make; make install
-
+* Unpack the tar file and run `./configure; make; make install`
 
 Running
 =======
-
 To start gipfel, enter 
 
-gipfel <image>
+	gipfel <image>
 
 where <image> is the actual picture in JPEG format.
 
@@ -43,11 +37,11 @@ for the viewpoint from which the picture was taken. Select a viewpoint and
 click "Ok".
 You can now use the controls in the control window to modify the view
 parameters. These are:
-- View direction
-- Nick angle
-- Tilt angle
-- Focal Length
-- Visibility
+* View direction
+* Nick angle
+* Tilt angle
+* Focal Length
+* Visibility
 
 Play around with these parameters, until you see the names of 
 mountains, which you already recognize on the picture.
@@ -58,10 +52,9 @@ If you have positioned at least two mountains, you can now click on
 the "comp" button in the control window. 
 
 You may also want to have a look at the screen video at
-http://www.ecademix.com/JohannesHofmann/gipfel.avi
+<http://www.ecademix.com/JohannesHofmann/gipfel.avi>
 for an example session.
 
-
 The Data File
 =============
 As stated before, gipfel needs GPS input data. The input data must be
@@ -88,10 +81,8 @@ Thanks to the kind permission of the owners of www.alpin-koordinaten.de, the
 standard gipfel tarball now includes a default datafile generated by 
 www.alpin-koordinaten.de
 
-
 GPS Tracks
 ==========
-
 Once you have determined the right parameters using the procedure described
 above, you can load GPS tracks and display them on the picture. Use the
 File->Load Track menu item. GPS tracks should be text files containing
@@ -103,20 +94,16 @@ GPS tracks are displayed with variable width depending on the distance
 of the way points from the current view point and the scale value. 
 You can also modify the width using the "Track Width" slider.
 
-
 Loading and Saving Images
 =========================
-
 gipfel allows to save the image paramters in the comment section of 
 the JPEG image. Use the File->Save Image menu item. 
 Note, that in the saved image all previous JPEG comments are removed.
 If you open an image containing gipfel image parameters, they are 
 automatcally set.
 
-
 Hidden Object Detection
 =======================
-
 gipfel tries to identify objects in its database, that are hidden by others.
 This is done by assuming that every object/peak has the form of a cone 
 with a fixed steapness. If such imaginary cone would hide the view to a
@@ -127,7 +114,6 @@ are displayed in blue.
 
 Refraction
 ==========
-
 Refraction caused by temperature and density gardients in the atmosphere is
 taken into account according to the approximation described by Tom Chester in:
 http://tchester.org/sgm/analysis/peaks/refraction_calculation.html
@@ -136,19 +122,19 @@ temperature T0 at view point level of 10°C.
 
 Stitching
 =========
-
 If you have multiple images from the same viewpoint referenced with gipfel
 you can stitch them together to form a panorama image.
 For stitching the input images must all have been correctly referenced
 with gipfel and saved (see "Loading and Saving Images").
-You can then call gipfel -s <img1> <img2> ...
+You can then call
+	gipfel -s <img1> <img2> ...
 to see the result in a window. Alternatively you can call
-gipfel -s -j <outimg> <img1> <img2> ...
+	gipfel -s -j <outimg> <img1> <img2> ...
 to save the result as a JPEG image to <outimg> or 
-gipfel -s -t <outdir> <img1> <img2> ...
+	gipfel -s -t <outdir> <img1> <img2> ...
 to save the result as multiple TIFF images to <outdir>.
 Use the multiple TIFF option for blending the result with enblend
-(http://enblend.sourceforge.net/).
+<http://enblend.sourceforge.net/>.
 The width and height of the result images can be adjusted with the
 -w and -h options.
 You can use the -b switch to enable bilinear interpolation, which 
@@ -166,19 +152,15 @@ overlap.
 If you want to open a stitched image in gipfel to locate the mountains
 on it, don't forget to choose Panoramic Projection!
 
-
 Exif Data
 =========
-
 gipfel tries to get useful information from the exif data of the
 input image. It uses the "Focal Length in 35mm Film" and the 
 "GPS Longitude", "GPS Latitude", and "GPS Height" parameters, if they
 exist.
 
-
 Lens Distortion
 ===============
-
 Typical lenses especially wide-angle lenses diverge from the optimal
 rectilinear projection.
 gipfel can now partly correct the resulting errors.
@@ -200,46 +182,33 @@ Independent of the distortion profiles one can also modify the
 distortion parameters per image.
 Distortion correction is also used when stitching panorama images.
 
-
 Troubleshooting
 ===============
-
-- Obviously gipfel can only be as good as its input data. If there is no 
-data about the mountains on your picture, you are out of luck...
-But as the data file format is pretty simple and GPS receivers are common, 
-you can build up your own datafile.
-
-- gipfel only works with full normal unmodified pictures taken with a 
-non-distorting standard objektive. If you have a panorama picture, you
-might want to try the "Panoramic Projection" support which 
-imlements a cylindrical projection (see "Projection" menu).
-
-- I have no idea, whether gipfel works correctly on pictures taken on
-the southern hemisphere, but I would appreciate any feedback about it.
-
+* Obviously gipfel can only be as good as its input data. If there is no 
+  data about the mountains on your picture, you are out of luck...
+  But as the data file format is pretty simple and GPS receivers are common, 
+  you can build up your own datafile.
+* gipfel only works with full normal unmodified pictures taken with a 
+  non-distorting standard objektive. If you have a panorama picture, you
+  might want to try the "Panoramic Projection" support which 
+  imlements a cylindrical projection (see "Projection" menu).
+* I have no idea, whether gipfel works correctly on pictures taken on
+  the southern hemisphere, but I would appreciate any feedback about it.
 
 Acknowledgements
 ================
-
-Thanks to the guys from http://www.alpin-koordinaten.de for their public
+Thanks to the guys from <http://www.alpin-koordinaten.de> for their public
 GPS database. 
-thanks to Carsten Clasohm for his great gallery at http://www.clasohm.com/.
-His pictures are good test cases for gipfel!
-Also have look at their other site http://www.alpen-panoramen.de/ !
-Thanks to George J. Gesslein II for his great program mathomatic
-(http://www.mathomatic.com/) which helped a lot to handle and simplify large
-Expressions.
-In newer versions I use maxima (http://maxima.sourceforge.net/) for
+Also have look at their other site <http://www.alpen-panoramen.de>.
+In newer versions I use maxima <http://maxima.sourceforge.net/> for
 symbolic computation and code generation.
-I also want to thank my brother Martin Hofmann for his suggestions and the
+I also want to thank my brother Martin for his suggestions and the
 discussions.
 
-
 DISCLAIMER
 ==========
-gipfel must NOT be used for real navigation. You should not rely on the 
+gipfel must __not__ be used for real navigation. You should not rely on the 
 results of gipfel.
 
-
 Johannes Hofmann
 (Johannes.Hofmann@gmx.de)