trunk/doc/README.txt

                  Routino : OpenStreetMap Routing Software
                  ========================================


   Routino is an application for finding a route between two points using
   the dataset of topographical information collected by
   http://www.OpenStreetMap.org.

   Starting from the raw OpenStreetMap data (in the form of the '.osm' XML
   files available on the internet) a custom database is generated that
   contains the information useful for routing. With this database and two
   points specified by latitude and longitude an optimum route (either
   shortest or quickest) is determined. The route is calculated for
   OpenStreetMap highways (roads, paths etc) using one of the common forms
   of transport defined in OpenStreetMap (foot, bicycle, horse, motorcar,
   motorbike etc).

   When processing the OpenStreetMap data the types of highways are
   recorded and these set default limits on the types of traffic allowed.
   More specific information about permissions for different types of
   transport are also recorded as are maximum speed limits. Further
   restrictions like oneway streets, weight, height, width and length
   limits are also included where specified. Additionally a set of
   properties of each highway are also recorded. The processing of the
   input file is controlled by a configuration file which determines the
   information that is used.

   When calculating a route the type of transport to be used is taken into
   account to ensure that the known restrictions are followed. Each of the
   different highway types can further be allowed or disallowed depending
   on preferences. For each type of highway a default speed limit is
   defined (although the actual speed used will be the lowest of the
   default and any specified in the original data). To make use of the
   information about restrictions the weight, height, width and length of
   the transport can also be specified. Further preferences about road
   properties (e.g. paved or not) can also be selected.

   The result of calculating the route can be presented in several
   different ways. An HTML file can be produced that contains a
   description of the route to take with instructions for each of the
   important junctions. The contents of the file are created based on a
   set of translations specified in a configuration file. The route is
   also available in a GPX (GPS eXchange) XML format. format file
   containing either every point and highway segment (a track file) or
   just a waypoint and translated instructions for the important junctions
   (a route file). Additionally there are two plain text files that
   contain all data points or just the important ones (intended for
   debugging and further processing).

   One of the design aims of Routino was to make the software are flexible
   as possible in selecting routing preferences but also have a sensible
   set of default values. Another design aim was that finding the optimum
   route should be very fast and most of the speed increases come from the
   carefully chosen and optimised data format.


Disclaimer
----------

   The route that is calculated by this software is only as good as the
   input data.

   Routino comes with ABSOLUTELY NO WARRANTY for the software itself or
   the route that is calculated by it.


Demonstration
-------------

   A live demonstration of the router for the UK is available on the
   internet:

   http://www.routino.org/uk/router.html

   The source code download available also includes a set of files that can
   be used to create your own interactive map.

   The interactive map is made possible by use of the OpenLayers Javascript
   library from http://www.openlayers.org/.


Documentation
-------------

   The algorithm used is described in the file ALGORITHM.txt and some
   notes about the limitations of the data is in DATA.txt.

   The configuration files and in particular the default set of rules for
   processing the OpenStreetMap data tags are described in detail in
   CONFIGURATION.txt and TAGGING.txt.  The format of the output files
   generated are described in OUTPUT.txt.

   Detailed information about how to use the programs is available in the
   file USAGE.txt and how to install it is in INSTALL.txt.


Status
------

   Version 1.0 of Routino was released on 8th April 2009.
   Version 1.1 of Routino was released on 13th June 2009.
   Version 1.2 of Routino was released on 21st October 2009.
   Version 1.3 of Routino was released on 21st January 2010.
   Version 1.4 of Routino was released on 31st May 2010.


License
-------

   This program is free software: you can redistribute it and/or modify it
   under the terms of the GNU Affero General Public License as published
   by the Free Software Foundation; either version 3 of the License, or
   (at your option) any later version.

   It is important to note that for this program I have decided to use the
   Affero GPLv3 instead of just using the GPL. This license adds
   additional requirements to anybody who provides a networked service
   using this software.


Copyright
---------

   Routino is copyright Andrew M. Bishop 2008-2010.

   Contact amb@gedanken.demon.co.uk for any questions or queries.


Homepage
--------

   The latest information about the program can be found on the homepage:

   http://www.routino.org/


Download
--------

   The program can be downloaded from:

   http://www.routino.org/download/


--------

Copyright 2008-2010 Andrew M. Bishop.
1	amb	429	Routino : OpenStreetMap Routing Software
2	amb	152	========================================
3
4
5			Routino is an application for finding a route between two points using
6			the dataset of topographical information collected by
7	amb	191	http://www.OpenStreetMap.org.
8	amb	152
9	amb	423	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	amb	152
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	amb	423	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	amb	152
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	amb	423	the transport can also be specified. Further preferences about road
36			properties (e.g. paved or not) can also be selected.
37	amb	152
38	amb	423	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	amb	152	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	amb	381
57	amb	152	Disclaimer
58	amb	381	----------
59	amb	152
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	amb	429	the route that is calculated by it.
65	amb	152
66	amb	381
67	amb	152	Demonstration
68	amb	381	-------------
69	amb	152
70	amb	429	A live demonstration of the router for the UK is available on the
71			internet:
72	amb	152
73	amb	425	http://www.routino.org/uk/router.html
74	amb	152
75	amb	191	The source code download available also includes a set of files that can
76			be used to create your own interactive map.
77	amb	152
78	amb	191	The interactive map is made possible by use of the OpenLayers Javascript
79			library from http://www.openlayers.org/.
80	amb	152
81	amb	381
82	amb	152	Documentation
83	amb	381	-------------
84	amb	152
85	amb	429	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	amb	152
88	amb	423	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	amb	152	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	amb	381
97	amb	152	Status
98	amb	381	------
99	amb	152
100			Version 1.0 of Routino was released on 8th April 2009.
101	amb	191	Version 1.1 of Routino was released on 13th June 2009.
102	amb	288	Version 1.2 of Routino was released on 21st October 2009.
103	amb	381	Version 1.3 of Routino was released on 21st January 2010.
104	amb	423	Version 1.4 of Routino was released on 31st May 2010.
105	amb	152
106	amb	381
107	amb	152	License
108	amb	381	-------
109	amb	152
110			This program is free software: you can redistribute it and/or modify it
111	amb	429	under the terms of the GNU Affero General Public License as published
112			by the Free Software Foundation; either version 3 of the License, or
113			(at your option) any later version.
114	amb	152
115			It is important to note that for this program I have decided to use the
116			Affero GPLv3 instead of just using the GPL. This license adds
117			additional requirements to anybody who provides a networked service
118			using this software.
119
120	amb	381
121	amb	152	Copyright
122	amb	381	---------
123	amb	152
124	amb	381	Routino is copyright Andrew M. Bishop 2008-2010.
125	amb	152
126			Contact amb@gedanken.demon.co.uk for any questions or queries.
127
128	amb	381
129	amb	152	Homepage
130	amb	381	--------
131	amb	152
132			The latest information about the program can be found on the homepage:
133
134	amb	425	http://www.routino.org/
135	amb	152
136	amb	381
137	amb	152	Download
138	amb	381	--------
139	amb	152
140			The program can be downloaded from:
141
142	amb	425	http://www.routino.org/download/
143	amb	152
144
145			--------
146
147	amb	381	Copyright 2008-2010 Andrew M. Bishop.