]> git.street.me.uk Git - andy/viking.git/blobdiff - README
Merge pull request #20 from huobos/zh_CN
[andy/viking.git] / README
diff --git a/README b/README
index c16e4abaeec1d96c33a960615775f3eb31f8ca73..b195a2ad51ba1f576386c760f46c6faf2e9c4cdb 100644 (file)
--- a/README
+++ b/README
@@ -1,25 +1,46 @@
-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.
+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.
 
 Website: http://viking.sf.net/
 
 
 
 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 repository:
+  $ git clone git://git.code.sf.net/p/viking/code viking
+
 Installing Viking
 =================
 
 Installing Viking
 =================
 
-If you downloaded viking from Git, you have to:
-  $ autogen.sh
+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
+
+If you downloaded Viking from Git, you have to:
+  $ ./autogen.sh
 
 Next, or if you downloaded a tarball, you have to:
   $ ./configure
   $ make
 
 
 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.
+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):
+If you wish to install Viking, you have to (as root):
   # make install
 
   # make install
 
-For detailled explaination on install, see INSTALL file.
+For detailed explanation on the install on Unix like systems,
+see the INSTALL file.
 
 Examples
 ========
 
 Examples
 ========