Open-Harbor/osrm-backend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 3 Wiki Activity

added README

Browse Source
This commit is contained in:
DennisSchiefer 2012-03-26 13:53:39 +01:00
parent 4b93107415
commit a89aa68686
1 changed files with 52 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
README Normal file
View File

@ -0,0 +1,52 @@
Overview
--------
The repository provides a Leaflet <<1>> based web frontend to the Open Source Routing Machine (Project-OSRM <<2>>).
The frontend is implemented in Javascript.
Data is fetched from routing and geocoding servers using JSONP queries.
The website is XHTML 1.0 Strict compliant.
A deployed version of the the web frontend can be seen at <<3>>.
Setup
-----
The frontend should work directly as provided.
Several settings - including the URL for the routing server and the geocoder server - can be specified in +OSRM.config.js+.
Different tile servers can be specified in +OSRM.main.js+.
Note that the URL shortener used for generating route links only works with URLs pointing to the official Project-OSRM website.
Branches
--------
- The +[master]+ branch will always point to the latest released version of the frontend.
- The +[develop]+ branch should always point to a working version that incorporates new features and bugfixes (think of it like a nightly-build).
- Other branches contain various work in progress.
Bugtracking
-----------
Please use the OSRM-Project bug tracker for submitting any bug reports or feature requests.
Integration into Project-OSRM repository
----------------------------------------
The Project-OSRM repository already contains the frontend repository as a submodule.
It will always point to the latest deployed version.
To successfully work a repository that contains submodules, use the following git commands (available in git 1.7.1+):
+git clone --recursive+::
to clone a repository and the contained submodules
+git pull && git submodule update+::
to pull the latest version of the repository and update its submodules if required
Note that the frontend can also be checked out independently of the Project-OSRM repository.
References
----------
[bibliography]
[[[1]]] Leaflet: http://leaflet.cloudmade.com/
[[[2]]] Project-OSRM: http://project-osrm.org/
[[[3]]] Project-OSRM Frontend: http://map.project-osrm.org/