Improve documentation
* Improve documentation about BRouter usage and the provided scripts (misc/scripts). * Document how to use BRouter with third-party apps on Android (Locus / OSMAnd). * Improved process_planet_pbf.sh map creation script to make use of osmupdate if available and avoid downloading the planet file if not needed.
This commit is contained in:
Phyks (Lucas Verney)
parent
6faaa6ec23
commit
6ed1850518
9 changed files with 274 additions and 27 deletions
139
README.md
139
README.md
|
|
@ -1,40 +1,129 @@
|
|||
BRouter
|
||||
=======
|
||||
|
||||
BRouter is a configurable OSM offline router with elevation awareness, Java + Android. Designed to be multi-modal with a particular emphasis on bicycle routing.
|
||||
BRouter is a configurable OSM offline router with elevation awareness, Java +
|
||||
Android. Designed to be multi-modal with a particular emphasis on bicycle
|
||||
and energy-based car routing.
|
||||
|
||||
For more infos see http://brouter.de/brouter
|
||||
For more infos see [http://brouter.de/brouter](http://brouter.de/brouter).
|
||||
|
||||
|
||||
## BRouter on Android
|
||||
|
||||
You can install the BRouter app on your Android device from
|
||||
[F-Droid](https://f-droid.org/packages/btools.routingapp) or [Google Play
|
||||
Store](https://play.google.com/store/apps/details?id=btools.routingapp). You
|
||||
can also [build BRouter](#build-and-install) yourself. You can find detailed
|
||||
documentation of the BRouter Android app in
|
||||
[`misc/readmes/readme.txt`](misc/readmes/readme.txt).
|
||||
|
||||
<a href="https://f-droid.org/packages/btools.routingapp" target="_blank">
|
||||
<img src="https://f-droid.org/badge/get-it-on.png" alt="Get it on F-Droid" height="90"/></a>
|
||||
<a href="https://play.google.com/store/apps/details?id=btools.routingapp" target="_blank">
|
||||
<img src="https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png" alt="Get it on Google Play" height="90"/></a>
|
||||
|
||||
### Android with Locus
|
||||
|
||||
## Build and Install
|
||||
You can use BRouter as the offline routing engine for [Locus
|
||||
Map](https://www.locusmap.eu/) on your Android device. This is currently the
|
||||
most featureful and maintained solutions for using BRouter on your Android
|
||||
device.
|
||||
|
||||
Compile with (Java 6!):
|
||||
|
||||
> mvn clean install -Dandroid.sdk.path=<your-sdk-path>
|
||||
|
||||
To skip building for Android, add ``-pl '!brouter-routing-app'``.
|
||||
|
||||
Next, download one or more [data file(s)](http://brouter.de/brouter/segments4/) (rd5) into the ``misc/segments4`` directory.
|
||||
|
||||
## Run
|
||||
|
||||
On Linux:
|
||||
> ./misc/scripts/standalone/server.sh
|
||||
|
||||
On Windows (using Bash):
|
||||
> ./misc/scripts/standalone/server.sh
|
||||
|
||||
On Windows (using CMD):
|
||||
> misc\scripts\standalone\server.cmd
|
||||
A full documentation on how to set this up is available at
|
||||
[https://www.locusmap.eu/locus-map-can-navigate-offline/](https://www.locusmap.eu/locus-map-can-navigate-offline/).
|
||||
|
||||
|
||||
Related Projects
|
||||
================
|
||||
### Android with OSMAnd
|
||||
|
||||
* https://github.com/nrenner/brouter-web
|
||||
* https://github.com/poutnikl/Brouter-profiles/wiki
|
||||
Alternatively, you can also use BRouter as the offline routing engine for
|
||||
[OSMAnd](https://osmand.net/) on your Android device.
|
||||
|
||||
A full documentation on how to set this up is available at
|
||||
[`misc/readmes/osmand/README.md`](misc/readmes/osmand/README.md).
|
||||
|
||||
|
||||
## BRouter on Windows/Linux/Mac OS
|
||||
|
||||
### Build and Install
|
||||
|
||||
To compile BRouter (including the BRouter Android app), use
|
||||
|
||||
```
|
||||
mvn clean install -Dandroid.sdk.path=<your-sdk-path>
|
||||
```
|
||||
|
||||
If you only want to compile BRouter and the server part (skipping the Android
|
||||
app), use
|
||||
|
||||
```
|
||||
mvn clean install -pl '!brouter-routing-app'
|
||||
```
|
||||
|
||||
You can use `-Dmaven.javadoc.skip=true` to skip the JavaDoc processing and
|
||||
`-DskipTests` to skip running the unitary tests.
|
||||
|
||||
|
||||
### Get the required segments (data) files
|
||||
|
||||
Routing data files are organised as 5*5 degree files,
|
||||
with the filename containing the south-west corner
|
||||
of the square, which means:
|
||||
|
||||
- You want to route near West48/North37 -> you need `W50_N35.rd5`
|
||||
- You want to route near East7/North47 -> you need `E5_N45.rd5`
|
||||
|
||||
These data files, called "segments" across BRouter, are generated from
|
||||
[OpenStreetMap](https://www.openstreetmap.org/) data and stored in a custom
|
||||
binary format (rd5) for improved efficiency of BRouter routing.
|
||||
|
||||
|
||||
#### Download them from brouter.de
|
||||
|
||||
Segments files from the whole planet are generated weekly at
|
||||
[http://brouter.de/brouter/segments4/](http://brouter.de/brouter/segments4/).
|
||||
|
||||
You can download one or more segments files, covering the area of the planet
|
||||
your want to route, into the `misc/segments4` directory.
|
||||
|
||||
#### Generate your own segments files
|
||||
|
||||
You can also generate the segments files you need directly from a planet dump
|
||||
of OpenStreetMap data (or a [GeoFabrik extract](https://download.geofabrik.de/)).
|
||||
|
||||
More documentation of this is available in the
|
||||
[`misc/readmes/mapcreation.md`](misc/readmes/mapcreation.md) file.
|
||||
|
||||
|
||||
### Run the BRouter HTTP server
|
||||
|
||||
Helpers scripts are provided in `misc/scripts/standalone` to quickly spawn a
|
||||
BRouter HTTP server for various platforms.
|
||||
|
||||
* Linux/Mac OS: `./misc/scripts/standalone/server.sh`
|
||||
* Windows (using Bash): `./misc/scripts/standalone/server.sh`
|
||||
* Windows (using CMD): `misc\scripts\standalone\server.cmd`
|
||||
|
||||
The API endpoints exposed by this HTTP server are documented in the
|
||||
[`brouter-server/src/main/java/btools/server/request/ServerHandler.java`](brouter-server/src/main/java/btools/server/request/ServerHandler.java)
|
||||
file.
|
||||
|
||||
|
||||
## Documentation
|
||||
|
||||
More documentation is available in the [`misc/readmes`](misc/readmes) folder.
|
||||
|
||||
|
||||
## Related Projects
|
||||
|
||||
* [nrenner/BRouter-web](https://github.com/nrenner/brouter-web), a web interface on
|
||||
top of the BRouter HTTP server. An online instance is available at
|
||||
[http://brouter.de/brouter-web/](http://brouter.de/brouter-web/).
|
||||
* [poutnikl/Brouter-profiles](https://github.com/poutnikl/Brouter-profiles/wiki),
|
||||
a collection of BRouter profiles.
|
||||
* [Phyks/BRouterTesting](https://github.com/Phyks/BrouterTesting), a
|
||||
collection of test cases for helping develop new BRouter profiles.
|
||||
|
||||
|
||||
## License
|
||||
|
||||
BRouter is released under an [MIT License](LICENSE).
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue