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,
   motorcycle 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 one-way 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 simplest type
   of turn restrictions (those formed from an initial way, a node and a
   second way) are also obeyed.

   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 in both OpenLayers and Leaflet versions:
   http://www.routino.org/uk-leaflet/
   http://www.routino.org/uk-openlayers/

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

   The source code download available below 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 or
   Leaflet Javascript library from http://www.openlayers.org/ or
   http://leafletjs.com/.


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

   The algorithm used is described in the file ALGORITHM.txt with some notes
   about the input data in DATA.txt and numerical limitations in LIMITS.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.
   Version 1.4.1 of Routino was released on 10th July 2010.
   Version 1.5 of Routino was released on 30th October 2010.
   Version 1.5.1 of Routino was released on 13th November 2010.
   Version 2.0 of Routino was released on 30th May 2011.
   Version 2.0.1 of Routino was released on 7th June 2011.
   Version 2.0.2 of Routino was released on 26th June 2011.
   Version 2.0.3 of Routino was released on 4th August 2011.
   Version 2.1 of Routino was released on 3rd October 2011.
   Version 2.1.1 of Routino was released on 23rd October 2011.
   Version 2.1.2 of Routino was released on 12th November 2011.
   Version 2.2 of Routino was released on 3rd March 2012.
   Version 2.3 of Routino was released on 21st July 2012.
   Version 2.3.1 of Routino was released on 11th August 2012.
   Version 2.3.2 of Routino was released on 6th October 2012.
   Version 2.4 of Routino was released on 8th December 2012.
   Version 2.4.1 of Routino was released on 17th December 2012.
   Version 2.5 of Routino was released on 9th February 2013.
   Version 2.5.1 of Routino was released on 20th April 2013.
   Version 2.6 of Routino was released on 6th July 2013.
   Version 2.7 of Routino was released on 22nd March 2014.

   The full version history is available in the NEWS.txt file.


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-2014.


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/

Subversion
- - - - -

   The source code can also be downloaded from the Subversion repository
   with a command like the following:

   svn co http://gedanken.org.uk/svn/cxref/trunk cxref

   The source code can also be browsed in the Subversion viewer which also
   has a list of the latest changes:

   http://www.routino.org/viewvc/trunk/
   http://www.routino.org/viewvc/trunk/?view=log


--------

Copyright 2008-2014 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	amb	1243	motorcycle 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	amb	738	restrictions like one-way 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	amb	738	properties (e.g. paved or not) can also be selected. The simplest type
37			of turn restrictions (those formed from an initial way, a node and a
38			second way) are also obeyed.
39	amb	152
40	amb	423	The result of calculating the route can be presented in several
41			different ways. An HTML file can be produced that contains a
42			description of the route to take with instructions for each of the
43			important junctions. The contents of the file are created based on a
44			set of translations specified in a configuration file. The route is
45			also available in a GPX (GPS eXchange) XML format. format file
46			containing either every point and highway segment (a track file) or
47			just a waypoint and translated instructions for the important junctions
48			(a route file). Additionally there are two plain text files that
49			contain all data points or just the important ones (intended for
50			debugging and further processing).
51
52	amb	152	One of the design aims of Routino was to make the software are flexible
53			as possible in selecting routing preferences but also have a sensible
54			set of default values. Another design aim was that finding the optimum
55			route should be very fast and most of the speed increases come from the
56			carefully chosen and optimised data format.
57
58	amb	381
59	amb	152	Disclaimer
60	amb	381	----------
61	amb	152
62			The route that is calculated by this software is only as good as the
63			input data.
64
65			Routino comes with ABSOLUTELY NO WARRANTY for the software itself or
66	amb	429	the route that is calculated by it.
67	amb	152
68	amb	381
69	amb	152	Demonstration
70	amb	381	-------------
71	amb	152
72	amb	429	A live demonstration of the router for the UK is available on the
73	amb	1530	internet in both OpenLayers and Leaflet versions:
74			http://www.routino.org/uk-leaflet/
75			http://www.routino.org/uk-openlayers/
76	amb	152
77	amb	1270	http://www.routino.org/uk/
78	amb	152
79	amb	1530	The source code download available below also includes a set of files
80			that can be used to create your own interactive map.
81	amb	152
82	amb	1492	The interactive map is made possible by use of the OpenLayers or
83			Leaflet Javascript library from http://www.openlayers.org/ or
84			http://leafletjs.com/.
85	amb	152
86	amb	381
87	amb	152	Documentation
88	amb	381	-------------
89	amb	152
90	amb	1254	The algorithm used is described in the file ALGORITHM.txt with some notes
91			about the input data in DATA.txt and numerical limitations in LIMITS.txt.
92	amb	152
93	amb	423	The configuration files and in particular the default set of rules for
94			processing the OpenStreetMap data tags are described in detail in
95			CONFIGURATION.txt and TAGGING.txt. The format of the output files
96			generated are described in OUTPUT.txt.
97
98	amb	152	Detailed information about how to use the programs is available in the
99			file USAGE.txt and how to install it is in INSTALL.txt.
100
101	amb	381
102	amb	152	Status
103	amb	381	------
104	amb	152
105			Version 1.0 of Routino was released on 8th April 2009.
106	amb	191	Version 1.1 of Routino was released on 13th June 2009.
107	amb	288	Version 1.2 of Routino was released on 21st October 2009.
108	amb	381	Version 1.3 of Routino was released on 21st January 2010.
109	amb	423	Version 1.4 of Routino was released on 31st May 2010.
110	amb	517	Version 1.4.1 of Routino was released on 10th July 2010.
111			Version 1.5 of Routino was released on 30th October 2010.
112	amb	525	Version 1.5.1 of Routino was released on 13th November 2010.
113	amb	738	Version 2.0 of Routino was released on 30th May 2011.
114	amb	781	Version 2.0.1 of Routino was released on 7th June 2011.
115	amb	801	Version 2.0.2 of Routino was released on 26th June 2011.
116	amb	828	Version 2.0.3 of Routino was released on 4th August 2011.
117	amb	903	Version 2.1 of Routino was released on 3rd October 2011.
118			Version 2.1.1 of Routino was released on 23rd October 2011.
119			Version 2.1.2 of Routino was released on 12th November 2011.
120	amb	979	Version 2.2 of Routino was released on 3rd March 2012.
121	amb	1026	Version 2.3 of Routino was released on 21st July 2012.
122	amb	1056	Version 2.3.1 of Routino was released on 11th August 2012.
123	amb	1087	Version 2.3.2 of Routino was released on 6th October 2012.
124	amb	1183	Version 2.4 of Routino was released on 8th December 2012.
125	amb	1216	Version 2.4.1 of Routino was released on 17th December 2012.
126	amb	1254	Version 2.5 of Routino was released on 9th February 2013.
127	amb	1454	Version 2.5.1 of Routino was released on 20th April 2013.
128			Version 2.6 of Routino was released on 6th July 2013.
129	amb	1530	Version 2.7 of Routino was released on 22nd March 2014.
130	amb	152
131	amb	517	The full version history is available in the NEWS.txt file.
132	amb	381
133	amb	517
134	amb	152	License
135	amb	381	-------
136	amb	152
137			This program is free software: you can redistribute it and/or modify it
138	amb	429	under the terms of the GNU Affero General Public License as published
139			by the Free Software Foundation; either version 3 of the License, or
140			(at your option) any later version.
141	amb	152
142			It is important to note that for this program I have decided to use the
143			Affero GPLv3 instead of just using the GPL. This license adds
144			additional requirements to anybody who provides a networked service
145			using this software.
146
147	amb	381
148	amb	152	Copyright
149	amb	381	---------
150	amb	152
151	amb	1530	Routino is copyright Andrew M. Bishop 2008-2014.
152	amb	152
153
154			Homepage
155	amb	381	--------
156	amb	152
157			The latest information about the program can be found on the homepage:
158
159	amb	425	http://www.routino.org/
160	amb	152
161	amb	381
162	amb	152	Download
163	amb	381	--------
164	amb	152
165			The program can be downloaded from:
166
167	amb	425	http://www.routino.org/download/
168	amb	152
169	amb	1530	Subversion
170			- - - - -
171	amb	152
172	amb	1530	The source code can also be downloaded from the Subversion repository
173			with a command like the following:
174
175			svn co http://gedanken.org.uk/svn/cxref/trunk cxref
176
177			The source code can also be browsed in the Subversion viewer which also
178			has a list of the latest changes:
179
180			http://www.routino.org/viewvc/trunk/
181			http://www.routino.org/viewvc/trunk/?view=log
182
183
184	amb	152	--------
185
186	amb	1530	Copyright 2008-2014 Andrew M. Bishop.