Use height units in the altitude readout for the cursor position on the status bar.

[andy/viking.git] / README

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