osrm-backend/README.md

48 lines
2.0 KiB
Markdown
Raw Normal View History

2015-05-01 19:30:44 -04:00
## About
2015-05-01 19:30:44 -04:00
The Open Source Routing Machine is a high performance routing engine written in C++11 designed to run on OpenStreetMap data.
2015-05-01 19:30:44 -04:00
## Current build status
2016-04-22 08:49:27 -04:00
| build config | status |
|:-------------|:-------|
| Linux | [![Build Status](https://travis-ci.org/Project-OSRM/osrm-backend.png?branch=master)](https://travis-ci.org/Project-OSRM/osrm-backend) |
| Windows | [![Build status](https://ci.appveyor.com/api/projects/status/4iuo3s9gxprmcjjh)](https://ci.appveyor.com/project/DennisOSRM/osrm-backend) |
2016-04-23 08:19:58 -04:00
| Coverage | [![Coverage Status](https://coveralls.io/repos/github/Project-OSRM/osrm-backend/badge.svg?branch=master)](https://coveralls.io/github/Project-OSRM/osrm-backend?branch=master) |
2016-04-22 08:49:27 -04:00
| LUAbind fork | [![Build Status](https://travis-ci.org/DennisOSRM/luabind.png?branch=master)](https://travis-ci.org/DennisOSRM/luabind) |
2015-05-01 19:30:44 -04:00
## Building
2015-05-01 19:30:44 -04:00
For instructions on how to [build](https://github.com/Project-OSRM/osrm-backend/wiki/Building-OSRM) and [run OSRM](https://github.com/Project-OSRM/osrm-backend/wiki/Running-OSRM), please consult [the Wiki](https://github.com/Project-OSRM/osrm-backend/wiki).
2015-05-01 19:30:44 -04:00
To quickly try OSRM use our [free and daily updated online service](http://map.project-osrm.org)
2015-05-02 09:18:13 -04:00
## Documentation
2016-04-29 06:20:51 -04:00
- [osrm-routed HTTP API documentation](docs/http.md)
- [libosrm API documentation](docs/libosrm.md)
2015-05-02 09:18:13 -04:00
## References in publications
When using the code in a (scientific) publication, please cite
```
@inproceedings{luxen-vetter-2011,
author = {Luxen, Dennis and Vetter, Christian},
title = {Real-time routing with OpenStreetMap data},
booktitle = {Proceedings of the 19th ACM SIGSPATIAL International Conference on Advances in Geographic Information Systems},
series = {GIS '11},
year = {2011},
isbn = {978-1-4503-1031-4},
location = {Chicago, Illinois},
pages = {513--516},
numpages = {4},
url = {http://doi.acm.org/10.1145/2093973.2094062},
doi = {10.1145/2093973.2094062},
acmid = {2094062},
publisher = {ACM},
address = {New York, NY, USA},
}
```