ben/brouter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Restrucuture documentation to smaller parts

Browse source
This commit is contained in:
Manuel Fuhr 2021-12-29 08:49:47 +01:00
parent 76f20ca864
commit 80681b78c6
12 changed files with 300 additions and 93 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/features/elevation.md
View file

@ -2,7 +2,7 @@
parent: Features
---
## Elevation algorithm
## Elevation awareness
Elevation awareness is the most important issue in bike routing if not routing
in a flat country. But in most routing software, elevation is either not handled

28
docs/features/offline.md
View file

@ -27,31 +27,3 @@ developers to implement simplifications into the routing algorithm that affect
the quality of the routing results. BRouter always does it's best on the
quality, but has a processing time that scales quadratic with distance, leading
to a limit at about 150km in air-distance, which is enough for a bikers daytrip.
### Installing the BETA Version of BRouter on an Android smartphone.
Before trying the Android app, you should have a look one the [online
version](/brouter-web) to see what it's doing.
What you should also do before trying the BRouter Android app is to install, an
get familiar with, one of the supported map-apps. This is either
[OsmAnd](http://www.osmand.net), which is a full offline navigation solution on
it's own, but especially it's a wonderful offline OSM map tool and is able to
give spoken directions to routes calculated either internally or externally.
Other options are [Locus](http://www.locusmap.eu/) or
[OruxMaps](http://www.oruxmaps.com/index_en.html).
The BRouter Android app assumes that at least one of OsmAnd, Locus or OruxMaps
is installed - it will not work otherwise.
If you are o.k. with all that, you can install the BRouter Android app from the
[brouter_1_6_1.zip](../brouter_bin/brouter_1_6_1.zip) installation ZIP-file
including the APK and read the [readme.txt](readme.txt) ( **READ ME !** ) for
details on how to add routing data and navigation profiles to your installation
and how the interfacing between BRouter and the supported map-tools works.
Navigation profiles and the lookup-data are [here](profiles2) Routing data files
per 5*5-degree square are [here](/brouter/segments4)
(The Map-Snapshot date is about 2 days before the timestamp of the routing data
files)

15
docs/features/vianogo.md
View file

@ -7,17 +7,10 @@ parent: Features
BRouter can process via-points and nogo-areas, and [brouter-web](/brouter-web)
offers on online interface to edit both of them.
For offline use, nogo-areas can be defined as wayoints using a special naming
convention. Handling of via-points during offline use depends on the mode of
operation, see the README for details.
NoGo-Areas are forbidden areas. In fact, these are areas, not points, with a
default radius of 20m around the given point. Every way that is touching this
disc of 20m radius is excluded by the routing algorithm. But the radius can also
be specified: a waypoint `nogo` default to 20m radius, but `nogo100` defines a
nogo area with 100m radius. Theres no limit in radius, so you can also exclude a
whole geographic region with a single nogo-area.
Nogo areas are useful if you encouter an obstacle that is not contained in the
underlying map. But they can also be useful in planning alternative routes by
excluding e.g. a certain bridge or ferry.
For offline use, nogo-areas can be defined as wayoints using a special naming
convention. Handling of via-points during offline use depends on the mode of
operation, see the README for details.