Add debug output view of the Back/Forward positions.

[andy/viking.git] / README

diff --git a/README b/README
index 9896ad2c9c15b406610fdafbef69385ccef6aec0..9807e6ff7368b0e4723766887fd110f7764eb414 100644 (file)
--- a/README
+++ b/README
@@ -1,23 +1,47 @@
-To compile:
+Viking is a free/open source program to manage GPS data. You can
+import, plot and create tracks and waypoints, show OSM, Terraserver
+and other maps, see real-time GPS position, get geocaches, control
+items, etc. It is written in C & the GTK+2 toolkit.
 
-If you downloaded viking from CVS, you have to:
-$ autogen.sh
+Website: http://viking.sf.net/
+
+
+Obtaining Viking
+================
+
+You can download tarball of latest released version at
+http://sourceforge.net/projects/viking/files
+
+You can also retrieve the latest development version on the official
+Git repo:
+  $ git clone git://viking.git.sourceforge.net/gitroot/viking/viking
+
+Installing Viking
+=================
+
+If you downloaded Viking from Git, you have to:
+  $ ./autogen.sh
 
 Next, or if you downloaded a tarball, you have to:
-$ ./configure
-$ make
+  $ ./configure
+  $ make
 
-If you whish to install viking, you have to (as root):
-# make install
+Check output of "./configure --help" for configuration options.  In
+particular, it is possible to disable some features, like
+--disable-google in order to disable any Google stuff.
 
+If you wish to install Viking, you have to (as root):
+  # make install
 
-Viking needs documentation! Any volunteers?
-After I get some core features down I'll start on documentation. I promise.
+For detailled explaination on install, see INSTALL file.
 
-To export as GPSMapper, the track/waypoint name should be in the format of:
+Examples
+========
 
-Name RGN## 0x####
+See test/ subdirectory for examples.
 
-or
+Documentation
+=============
 
-Name RGN## 0x##
+See doc/ and help/ subdirectories for documentation.
+You can also access user manual via Help menu entry.