git.maemo.org Git - routino/blob - doc/README.txt

   1                   Routino : OpenStreetMap Routing Software
   2                   ========================================
   3
   4
   5    Routino is an application for finding a route between two points using
   6    the dataset of topographical information collected by
   7    http://www.OpenStreetMap.org.
   8
   9    Starting from the raw OpenStreetMap data (in the form of the '.osm' XML
  10    files available on the internet) a custom database is generated that
  11    contains the information useful for routing. With this database and two
  12    points specified by latitude and longitude an optimum route (either
  13    shortest or quickest) is determined. The route is calculated for
  14    OpenStreetMap highways (roads, paths etc) using one of the common forms
  15    of transport defined in OpenStreetMap (foot, bicycle, horse, motorcar,
  16    motorbike etc).
  17
  18    When processing the OpenStreetMap data the types of highways are
  19    recorded and these set default limits on the types of traffic allowed.
  20    More specific information about permissions for different types of
  21    transport are also recorded as are maximum speed limits. Further
  22    restrictions like oneway streets, weight, height, width and length
  23    limits are also included where specified. Additionally a set of
  24    properties of each highway are also recorded. The processing of the
  25    input file is controlled by a configuration file which determines the
  26    information that is used.
  27
  28    When calculating a route the type of transport to be used is taken into
  29    account to ensure that the known restrictions are followed. Each of the
  30    different highway types can further be allowed or disallowed depending
  31    on preferences. For each type of highway a default speed limit is
  32    defined (although the actual speed used will be the lowest of the
  33    default and any specified in the original data). To make use of the
  34    information about restrictions the weight, height, width and length of
  35    the transport can also be specified. Further preferences about road
  36    properties (e.g. paved or not) can also be selected.
  37
  38    The result of calculating the route can be presented in several
  39    different ways. An HTML file can be produced that contains a
  40    description of the route to take with instructions for each of the
  41    important junctions. The contents of the file are created based on a
  42    set of translations specified in a configuration file. The route is
  43    also available in a GPX (GPS eXchange) XML format. format file
  44    containing either every point and highway segment (a track file) or
  45    just a waypoint and translated instructions for the important junctions
  46    (a route file). Additionally there are two plain text files that
  47    contain all data points or just the important ones (intended for
  48    debugging and further processing).
  49
  50    One of the design aims of Routino was to make the software are flexible
  51    as possible in selecting routing preferences but also have a sensible
  52    set of default values. Another design aim was that finding the optimum
  53    route should be very fast and most of the speed increases come from the
  54    carefully chosen and optimised data format.
  55
  56
  57 Disclaimer
  58 ----------
  59
  60    The route that is calculated by this software is only as good as the
  61    input data.
  62
  63    Routino comes with ABSOLUTELY NO WARRANTY for the software itself or
  64    the route that is calculated by it.
  65
  66
  67 Demonstration
  68 -------------
  69
  70    A live demonstration of the router for the UK is available on the
  71    internet:
  72
  73    http://www.routino.org/uk/router.html
  74
  75    The source code download available also includes a set of files that can
  76    be used to create your own interactive map.
  77
  78    The interactive map is made possible by use of the OpenLayers Javascript
  79    library from http://www.openlayers.org/.
  80
  81
  82 Documentation
  83 -------------
  84
  85    The algorithm used is described in the file ALGORITHM.txt and some
  86    notes about the limitations of the data is in DATA.txt.
  87
  88    The configuration files and in particular the default set of rules for
  89    processing the OpenStreetMap data tags are described in detail in
  90    CONFIGURATION.txt and TAGGING.txt.  The format of the output files
  91    generated are described in OUTPUT.txt.
  92
  93    Detailed information about how to use the programs is available in the
  94    file USAGE.txt and how to install it is in INSTALL.txt.
  95
  96
  97 Status
  98 ------
  99
 100    Version 1.0 of Routino was released on 8th April 2009.
 101    Version 1.1 of Routino was released on 13th June 2009.
 102    Version 1.2 of Routino was released on 21st October 2009.
 103    Version 1.3 of Routino was released on 21st January 2010.
 104    Version 1.4 of Routino was released on 31st May 2010.
 105    Version 1.4.1 of Routino was released on 10th July 2010.
 106    Version 1.5 of Routino was released on 30th October 2010.
 107    Version 1.5.1 of Routino was released on 13th November 2010.
 108
 109    The full version history is available in the NEWS.txt file.
 110
 111
 112 License
 113 -------
 114
 115    This program is free software: you can redistribute it and/or modify it
 116    under the terms of the GNU Affero General Public License as published
 117    by the Free Software Foundation; either version 3 of the License, or
 118    (at your option) any later version.
 119
 120    It is important to note that for this program I have decided to use the
 121    Affero GPLv3 instead of just using the GPL. This license adds
 122    additional requirements to anybody who provides a networked service
 123    using this software.
 124
 125
 126 Copyright
 127 ---------
 128
 129    Routino is copyright Andrew M. Bishop 2008-2010.
 130
 131    Contact amb@gedanken.demon.co.uk for any questions or queries.
 132
 133
 134 Homepage
 135 --------
 136
 137    The latest information about the program can be found on the homepage:
 138
 139    http://www.routino.org/
 140
 141
 142 Download
 143 --------
 144
 145    The program can be downloaded from:
 146
 147    http://www.routino.org/download/
 148
 149
 150 --------
 151
 152 Copyright 2008-2010 Andrew M. Bishop.