Overhault the README
This commit is contained in:
		
							parent
							
								
									d3a5cadb6c
								
							
						
					
					
						commit
						bac6b729bf
					
				
							
								
								
									
										39
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										39
									
								
								README.md
									
									
									
									
									
								
							| @ -9,7 +9,6 @@ The Open Source Routing Machine is a high performance routing engine written in | |||||||
| | Linux        | [](https://travis-ci.org/Project-OSRM/osrm-backend) | | | Linux        | [](https://travis-ci.org/Project-OSRM/osrm-backend) | | ||||||
| | Windows      | [](https://ci.appveyor.com/project/DennisOSRM/osrm-backend) | | | Windows      | [](https://ci.appveyor.com/project/DennisOSRM/osrm-backend) | | ||||||
| | Coverage     | [](https://coveralls.io/github/Project-OSRM/osrm-backend?branch=master) | | | Coverage     | [](https://coveralls.io/github/Project-OSRM/osrm-backend?branch=master) | | ||||||
| | LUAbind fork | [](https://travis-ci.org/DennisOSRM/luabind) | |  | ||||||
| 
 | 
 | ||||||
| ## Building | ## Building | ||||||
| 
 | 
 | ||||||
| @ -19,9 +18,47 @@ To quickly try OSRM use our [free and daily updated online service](http://map.p | |||||||
| 
 | 
 | ||||||
| ## Documentation | ## Documentation | ||||||
| 
 | 
 | ||||||
|  | ### Full documentation | ||||||
|  | 
 | ||||||
| - [osrm-routed HTTP API documentation](docs/http.md) | - [osrm-routed HTTP API documentation](docs/http.md) | ||||||
| - [libosrm API documentation](docs/libosrm.md) | - [libosrm API documentation](docs/libosrm.md) | ||||||
| 
 | 
 | ||||||
|  | ### Quick start | ||||||
|  | 
 | ||||||
|  | Building OSRM assuming all dependencies are installed: | ||||||
|  | 
 | ||||||
|  | ``` | ||||||
|  | mkdir -p build | ||||||
|  | cd build | ||||||
|  | cmake .. -DCMAKE_BUILD_TYPE=Release | ||||||
|  | cmake --build . | ||||||
|  | sudo cmake --build . --target install | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
|  | Loading preparing a dataset and starting the server: | ||||||
|  | 
 | ||||||
|  | ``` | ||||||
|  | osrm-extract data.osm.pbf -p profiles/car.lua | ||||||
|  | osrm-contract data.osrm | ||||||
|  | osrm-routed data.osrm | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
|  | Running a query on your local server: | ||||||
|  | 
 | ||||||
|  | ``` | ||||||
|  | curl http://127.0.0.1:5000/13.388860,52.517037;13.385983,52.496891?steps=true&alternatives=true | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
|  | ### Running a request against the Demo Server | ||||||
|  | 
 | ||||||
|  | First read the [API usage policy](https://github.com/Project-OSRM/osrm-backend/wiki/Api-usage-policy). | ||||||
|  | 
 | ||||||
|  | Then run simple query with instructions and alternatives on Berlin: | ||||||
|  | 
 | ||||||
|  | ``` | ||||||
|  | curl https://router.project-osrm.org/13.388860,52.517037;13.385983,52.496891?steps=true&alternatives=true | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
| ## References in publications | ## References in publications | ||||||
| 
 | 
 | ||||||
| When using the code in a (scientific) publication, please cite | When using the code in a (scientific) publication, please cite | ||||||
|  | |||||||
		Loading…
	
		Reference in New Issue
	
	Block a user