vcs.maemo.org Git - routino/blob - doc/html/index.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <HTML>
   3
   4 <!--
   5  Routino documentation - index
   6
   7  Part of the Routino routing software.
   8
   9  This file Copyright 2008-2010 Andrew M. Bishop
  10
  11  This program is free software: you can redistribute it and/or modify
  12  it under the terms of the GNU Affero General Public License as published by
  13  the Free Software Foundation, either version 3 of the License, or
  14  (at your option) any later version.
  15
  16  This program is distributed in the hope that it will be useful,
  17  but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  GNU Affero General Public License for more details.
  20
  21  You should have received a copy of the GNU Affero General Public License
  22  along with this program.  If not, see http://www.gnu.org/licenses/.
  23 -->
  24
  25 <HEAD>
  26 <TITLE>Routino : Documentation</TITLE>
  27 <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  28 <LINK href="style.css" type="text/css" rel="stylesheet">
  29 </HEAD>
  30
  31 <BODY>
  32
  33 <!-- Header Start -->
  34
  35 <div class="header" align="center">
  36
  37 <h1>Routino : Documentation</h1>
  38
  39 <hr>
  40 </div>
  41
  42 <!-- Header End -->
  43
  44 <!-- Content Start -->
  45
  46 <div class="content">
  47
  48
  49 <h2><a name="H_1_1"></a>Data</h2>
  50
  51 A good router relies on good data and the
  52 <a class="ext" title="OpenStreetMap" href="http://www.openstreetmap.org/">OpenStreetMap</a>
  53 data is a good source.  There are however a number of things that need to be
  54 considered about
  55 <a href="data.html" title="Data considerations">the data used</a>.
  56
  57
  58 <h2><a name="H_1_2"></a>Tagging</h2>
  59
  60 In addition to the raw data the way that are tags are used is also important.
  61 With Routino the
  62 <a title="Tagging" href="tagging.html">tagging rules</a>
  63 are contained in a configuration file and can easily be customised to change the
  64 interpretation of each tag.
  65
  66
  67 <h2><a name="H_1_3"></a>Program Usage</h2>
  68
  69 There are four programs that make up this software, two create the routing
  70 database and use the information in it and the other two perform additional functions.
  71 <a href="usage.html" title="Program Usage">Full instructions</a>
  72 for using the four programs are provided.
  73
  74
  75 <h2><a name="H_1_4"></a>Configuration Files</h2>
  76
  77 When the programs are run they read in one or more
  78 <a href="configuration.html" title="Configuration Files">configuration files</a>.
  79 These files contain information about the routing preferences (types of highways,
  80 prefered speeds etc), tagging rules and translation information for the outputs.
  81
  82
  83 <h2><a name="H_1_5"></a>Output Files</h2>
  84
  85 The final result of running the router is one or more
  86 <a href="output.html" title="Output Files">output files</a>
  87 that contain the calculated route.
  88
  89
  90 <h2><a name="H_1_6"></a>Algorithm</h2>
  91
  92 The <a title="Algorithm" href="algorithm.html">algorithm</a> that is used by
  93 Routino takes the OpenStreetMap data and creates a local database of the
  94 important information for rapid routing.
  95
  96
  97 <h2><a name="H_1_7"></a>Installation</h2>
  98
  99 The Routino source code comes with a set of files that can be used to create
 100 a working server very easily.  The full information about
 101 <a href="installation.html" title="Installation">installation</a>
 102 describes how to compile the programs and install them.
 103
 104
 105 </div>
 106
 107 <!-- Content End -->
 108
 109 <!-- Footer Start -->
 110
 111 <div class="footer" align="center">
 112 <hr>
 113
 114 <address>
 115 &copy; Andrew M. Bishop = &lt;amb "at" gedanken.demon.co.uk&gt;
 116 </address>
 117
 118 </div>
 119
 120 <!-- Footer End -->
 121
 122 </BODY>
 123
 124 </HTML>