]> git.street.me.uk Git - andy/viking.git/blobdiff - README
Rework the a_dialog_new_waypoint function
[andy/viking.git] / README
diff --git a/README b/README
index 707af7c928576636c297121d08e8ed5f2f587cfa..c16e4abaeec1d96c33a960615775f3eb31f8ca73 100644 (file)
--- a/README
+++ b/README
@@ -1,26 +1,33 @@
-To compile:
+Viking is a free/open source program to manage GPS data. You can import and plot tracks and waypoints, show Terraserver maps under it, add coordinate lines, make new tracks and waypoints, hide different things, etc. It is written in C with the GTK+ 2.
+
+Website: http://viking.sf.net/
+
+
+Installing Viking
+=================
 
 If you downloaded viking from Git, you have to:
-$ autogen.sh
+  $ autogen.sh
 
 Next, or if you downloaded a tarball, you have to:
-$ ./configure
-$ make
+  $ ./configure
+  $ make
 
 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
-
+  # 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.