Some spelling fixes in a comment

[andy/viking.git] / README

diff --git a/README b/README
index 748a5266be4aa5a274cecaa01f404f66289af1e4..96c8ca15c89396f645815c5917a11e1f25d467f7 100644 (file)
--- a/README
+++ b/README
@@ -1,20 +1,67 @@
-To compile:
+Viking is a free/open source program to manage GPS data. You can
+import, plot and create tracks, routes and waypoints, show OSM
+and other maps, generate maps (using Mapnik),
+see real-time GPS position, Geotag Images,
+control items, upload/download OSM Traces and more.
+It is written mainly in C with some C++ and uses 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 repository:
+  $ git clone git://git.code.sf.net/p/viking/code viking
 
-To export as GPSMapper, the track/waypoint name should be in the format of:
+Installing Viking
+=================
 
-Name RGN## 0x####
+Dependencies
+------------
 
-or
+On debian Sid, following packages must be installed before building:
+  # sudo apt install gtk-doc-tools  gnome-doc-utils libpng-dev libgtk-3-dev libgexiv2-dev libgps-dev libbz2-dev libmagic-dev
+nettle-dev libzip-dev libicu-dev
 
-Name RGN## 0x##
+The following packages are needed (they are included by default in Debian Sid, but not in other distributions). They
+must be installed too:
+  # sudo apt-get install libcurl4-gnutls-dev libgtk2.0-dev
+
+The following packages are also used, but they can be disabled with configure option, if desired:
+  # sudo apt-get install libsqlite3-dev nettle-dev libmapnik-dev
+
+Actual Build
+------------
+
+If you downloaded Viking from Git, you have to:
+  $ ./autogen.sh
+
+Next, or if you downloaded a tarball, you have to:
+  $ ./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 wish to install Viking, you have to (as root):
+  # make install
+
+For detailed explanation on the install on Unix like systems,
+see the 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.