Add Windows' path to configuration files

[andy/viking.git] / README

diff --git a/README b/README
index 748a5266be4aa5a274cecaa01f404f66289af1e4..5bd497abed50eafb0bb7a5f820507c1107ecf3e3 100644 (file)
--- a/README
+++ b/README
@@ -1,20 +1,43 @@
-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.
 
-make
+Website: http://viking.sf.net/
 
-Or if you're using GTK 2.2:
 
-make -f Makefile_GTK_2_2
+Obtaining Viking
+================
 
-... and ignore the GtkColorButton warnings etc.
+You can download tarball of latest released version at
+http://sourceforge.net/projects/viking/files
 
-Viking needs documentation! Any volunteers?
-After I get some core features down I'll start on documentation. I promise.
+You can also retrieve the latest development version on the official
+Git repo:
+  $ git clone git://viking.git.sourceforge.net/gitroot/viking/viking
 
-To export as GPSMapper, the track/waypoint name should be in the format of:
+Installing Viking
+=================
 
-Name RGN## 0x####
+If you downloaded viking from Git, you have to:
+  $ autogen.sh
 
-or
+Next, or if you downloaded a tarball, you have to:
+  $ ./configure
+  $ make
 
-Name RGN## 0x##
+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 whish to install viking, you have to (as root):
+  # make install
+
+For detailled explaination on install, see INSTALL file.
+
+Examples
+========
+
+See test/ subdirectory for examples.
+
+Documentation
+=============
+
+See doc/ and help/ subdirectories for documentation.
+You can also access user manual via Help menu entry.