bedroomghost/brouter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix typos in markdown files

Browse Source
This commit is contained in:
Waldir Pimenta 2024-01-15 19:31:07 +00:00
parent c72fc5f74d
commit b01aff2e4e
7 changed files with 41 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/developers/algorithm.md
View File

@ -50,7 +50,7 @@ The reason that `c=0` (=Dijkstra) is used in the second pass and not `c=1`
(=A-Star) is simply that for `c=0` the open-set is smaller, because many paths (=A-Star) is simply that for `c=0` the open-set is smaller, because many paths
run into the cutoff at an early time and do not have to be managed in the run into the cutoff at an early time and do not have to be managed in the
open-set anymore. And because the size of the open-set has an impact on open-set anymore. And because the size of the open-set has an impact on
performance and memory consumption, c=0 is choosen for the second pass. The performance and memory consumption, c=0 is chosen for the second pass. The
open-set is what's displayed in the graphical app-animation of the brouter-app. open-set is what's displayed in the graphical app-animation of the brouter-app.
However, you can change the coefficients of both passes in the routing-profile However, you can change the coefficients of both passes in the routing-profile
@ -72,7 +72,7 @@ assign pass2coefficient=-1
``` ```
Some more words on the conditions that the path-cost-funtion g(x) has to Some more words on the conditions that the path-cost-funtion g(x) has to
fullfill. Mathematically it reads that you need *non-negative edge costs*, but fulfill. Mathematically it reads that you need *non-negative edge costs*, but
the meaning is that at the time you reach a node you must be sure that no other the meaning is that at the time you reach a node you must be sure that no other
path reaching this node at a later time can lead to a better result over all. path reaching this node at a later time can lead to a better result over all.
@ -94,5 +94,5 @@ realized later, or maybe not.
Strictly speaking, neither Dijkstra nor A-Star can handle that. And in BRouter, Strictly speaking, neither Dijkstra nor A-Star can handle that. And in BRouter,
there's no real solution. There's a mechanism to delay the node-decision one there's no real solution. There's a mechanism to delay the node-decision one
step further and so to reduce the probablity of glitches from that dirtyness, step further and so to reduce the probability of glitches from that dirtiness,
but mainly the solution is *don't care*. but mainly the solution is *don't care*.

2
docs/developers/android_service.md
View File

@ -87,7 +87,7 @@ Another variant is to send parameters for an existing profile that are different
With the version 1.7.1 it is possible to collect parameters from the profile. With the version 1.7.1 it is possible to collect parameters from the profile.
The variable parameters are defined like this The variable parameters are defined like this
``` ```
assign avoid_path = false # %avoid_path% | Set to true to avoid pathes | boolean assign avoid_path = false # %avoid_path% | Set to true to avoid paths | boolean
``` ```
You probably know that from the web client, it builds an option dialog for this. You probably know that from the web client, it builds an option dialog for this.
Now you could do that with an calling app. Now you could do that with an calling app.

4
docs/features/vianogo.md
View File

@ -7,10 +7,10 @@ parent: Features
BRouter can process via-points and nogo-areas, and [brouter-web](/brouter-web) BRouter can process via-points and nogo-areas, and [brouter-web](/brouter-web)
offers on online interface to edit both of them. offers on online interface to edit both of them.
Nogo areas are useful if you encouter an obstacle that is not contained in the Nogo areas are useful if you encounter an obstacle that is not contained in the
underlying map. But they can also be useful in planning alternative routes by underlying map. But they can also be useful in planning alternative routes by
excluding e.g. a certain bridge or ferry. excluding e.g. a certain bridge or ferry.
For offline use, nogo-areas can be defined as wayoints using a special [naming convention](../users/android_advanced.md#using-nogo-areas). For offline use, nogo-areas can be defined as waypoints using a special [naming convention](../users/android_advanced.md#using-nogo-areas).
Handling of via-points during offline use depends on the mode of operation, see Handling of via-points during offline use depends on the mode of operation, see
the README for details. the README for details.

3
docs/privacy_policy.md
View File

@ -16,7 +16,6 @@
## Contact ## Contact
Get in contact to the delevoper team via Github Get in contact to the developer team via Github
https://github.com/abrensch/brouter https://github.com/abrensch/brouter

27
docs/revisions.md
View File

@ -71,12 +71,12 @@ Android
- Minor bug fixes - Minor bug fixes
### [brouter-1.7.2.zip](../brouter_bin/brouter-1.7.2.zip) (19.07.2023) ### [brouter-1.7.2.zip](../brouter_bin/brouter-1.7.2.zip) (19.07.2023)
- Re-index Json output - Re-index Json output
Note: This is different to releases 1.7.0 and 1.7.1. It is recommended to use the current version to avoid breaks in voice hint output for GeoJson. Note: This is different to releases 1.7.0 and 1.7.1.
It is recommended to use the current version to avoid breaks in voice hint
output for GeoJson.
### [brouter-1.7.1.zip](../brouter_bin/brouter-1.7.1.zip) (12.07.2023) ### [brouter-1.7.1.zip](../brouter_bin/brouter-1.7.1.zip) (12.07.2023)
@ -87,7 +87,6 @@ Android
- Add silent mode for calling apps - Add silent mode for calling apps
- Fixed download lookups.dat when download only single rd5 tile. - Fixed download lookups.dat when download only single rd5 tile.
Library Library
- Update matching points rules on areas with longer distances between way points - Update matching points rules on areas with longer distances between way points
@ -191,7 +190,7 @@ Library
- performance improvements - performance improvements
- Bicycle+Foot ETA (estimated time of arrival) - Bicycle+Foot ETA (estimated time of arrival)
- ETA data in GPX for Locus + OsmAnd - ETA data in GPX for Locus + OsmAnd
- more precice distance calculation - more precise distance calculation
- weighted nogos - weighted nogos
- BRouter-Web related additions - BRouter-Web related additions
- maxspeed:forrward/backward - maxspeed:forrward/backward
@ -255,7 +254,7 @@ Library
- filtering out unused way tags to increase profile cache efficiency - filtering out unused way tags to increase profile cache efficiency
- cache sizing depending on android memory class - cache sizing depending on android memory class
- fixed *ups* bug at very long distances - fixed *ups* bug at very long distances
- fixed a bug when using repeat-timeout shortcut without a cordinate source - fixed a bug when using repeat-timeout shortcut without a coordinate source
### [brouter_1_4_4.zip](../brouter_bin/brouter_1_4_4.zip) (29.08.2016) ### [brouter_1_4_4.zip](../brouter_bin/brouter_1_4_4.zip) (29.08.2016)
@ -267,16 +266,16 @@ Library
### [brouter_1_4_3.zip](../brouter_bin/brouter_1_4_3.zip) (06.08.2016) ### [brouter_1_4_3.zip](../brouter_bin/brouter_1_4_3.zip) (06.08.2016)
- Option for sending profiles via service interface - Option for sending profiles via service interface
- more aggresive profile replacement at version upgrade - more aggressive profile replacement at version upgrade
- fixed a serious rounding bug when reading locus/orux waypoints - fixed a serious rounding bug when reading locus/orux waypoints
### [brouter_1_4_2.zip](../brouter_bin/brouter_1_4_2.zip) (16.05.2016) ### [brouter_1_4_2.zip](../brouter_bin/brouter_1_4_2.zip) (16.05.2016)
- turn instructions, elevation on locus waypoints - turn instructions, elevation on locus waypoints
- turn-instructions, shift to less ambigious angles - turn-instructions, shift to less ambiguous angles
- turn-instructions, locus transport mode cleanup - turn-instructions, locus transport mode cleanup
### [brouter_1_4_1.zip](../brouter_bin/brouter_1_4_1.zip) (09.05.2016 ### [brouter_1_4_1.zip](../brouter_bin/brouter_1_4_1.zip) (09.05.2016)
- turn instructions, fixed locus roundabaouts - turn instructions, fixed locus roundabaouts
- added xor, lesser, sub operators for profiles - added xor, lesser, sub operators for profiles
@ -350,12 +349,12 @@ Library
- special, fast handling for trivial recalculations for timeout-free - special, fast handling for trivial recalculations for timeout-free
recalculations recalculations
- fixed the scaling for high-density screens in the download manager - fixed the scaling for high-density screens in the download manager
- added more [configuration options](https://brouter.de/brouter/kitkat_survival_readme.txt) to work - added more [configuration options](https://brouter.de/brouter/kitkat_survival_readme.txt)
around the kitkat (Android 4.4) issues to work around the kitkat (Android 4.4) issues
### [brouter_0_9_9.zip](../brouter_bin/brouter_0_9_9.zip) (18.4.2014, hot-fix 11.5.2014) ### [brouter_0_9_9.zip](../brouter_bin/brouter_0_9_9.zip) (18.4.2014, hot-fix 11.5.2014)
- new (google-play compatible) signing key, UNINSTALL NECCESSARY! - new (google-play compatible) signing key, UNINSTALL NECESSARY!
- added crc checksums to datafiles - added crc checksums to datafiles
- fixed a bug in accessing the last 64k of a datafile - fixed a bug in accessing the last 64k of a datafile
- extended basedir-proposals (**Fixed Android 4.4 issue on 11.5.2014**) - extended basedir-proposals (**Fixed Android 4.4 issue on 11.5.2014**)
@ -379,7 +378,7 @@ Library
- improved nogo-handling in service interface (inverse logic, routing mode - improved nogo-handling in service interface (inverse logic, routing mode
stores veto-list) stores veto-list)
- added waypoint-selection dialogs when from/to not given - added waypoint-selection dialogs when from/to not given
- summary page after service-mode confifuration update - summary page after service-mode configuration update
- allowed configuration of BRouter's servicemodes without any supported - allowed configuration of BRouter's servicemodes without any supported
maptool installed maptool installed
- added a redirection-workaround for the tracks-output directory - added a redirection-workaround for the tracks-output directory
@ -396,7 +395,7 @@ Library
### [brouter_0_9_5.zip](../brouter_bin/brouter_0_9_5.zip) (20.10.2013) ### [brouter_0_9_5.zip](../brouter_bin/brouter_0_9_5.zip) (20.10.2013)
- some performance improvments - some performance improvements
- support for car-subset datafiles - support for car-subset datafiles
- timeout-free partial recalcs in service-mode - timeout-free partial recalcs in service-mode
- added java-version (executable jar) to distribution zip - added java-version (executable jar) to distribution zip

15
docs/users/android_advanced.md
View File

@ -43,7 +43,7 @@ _routing-profile_.
#### storageconfig.txt #### storageconfig.txt
`storageconfig.txt` is used to specifiy additional paths which BRouter should `storageconfig.txt` is used to specify additional paths which BRouter should
use. use.
* `secondary_segment_dir` points to an additional directory containing routing * `secondary_segment_dir` points to an additional directory containing routing
@ -86,8 +86,8 @@ personal routing preferences.
## Routing via _file interface_ ## Routing via _file interface_
The other option is using the BRouter app to calculate a route. This is the The other option is using the BRouter app to calculate a route. This is the
prefered option when calculating long-distance-routes that would not finish preferred option when calculating long-distance-routes that would not finish
within the 60 seconds timout if calculated via the _service interface_. within the 60 seconds timeout if calculated via the _service interface_.
To do this, start the BRouter app, select two or more waypoints and then start To do this, start the BRouter app, select two or more waypoints and then start
the route calculation. BRouter reads waypoints from the `import` folder the route calculation. BRouter reads waypoints from the `import` folder
@ -97,9 +97,10 @@ If your waypoint database contains a `from` and `to` waypoint the waypoint
selection will be skipped. BRouter also uses `via1`, ..., `via9` as via selection will be skipped. BRouter also uses `via1`, ..., `via9` as via
waypoints. waypoints.
If a route is calculated, it is stored as `brouter0.gpx`. BRouter stores the route in If a route is calculated, it is stored as `brouter0.gpx`. BRouter stores the
`<basedir>/import/tracks` directory. If started once more with identical input, route in `<basedir>/import/tracks` directory. If started once more with
BRouter will store a second route `brouter1.gpx` for the first alternative and so on. identical input, BRouter will store a second route `brouter1.gpx` for the first
alternative and so on.
## Mixed operation: _timeout-free recalculations_ ## Mixed operation: _timeout-free recalculations_
@ -116,7 +117,7 @@ _reference track_ in the `brouter/modes` subdirectory.
If afterwards a route to the exact same destination is calculated via the If afterwards a route to the exact same destination is calculated via the
service interface, BRouter uses a special calculation mode that makes use of the service interface, BRouter uses a special calculation mode that makes use of the
reference track for faster processing that is guaranteed to give a result within reference track for faster processing that is guaranteed to give a result within
60 seconds. _Exact same_ destination means withing 5m, so best use the same 60 seconds. _Exact same_ destination means within 5m, so best use the same
waypoint for re-calculating that you used for the initial calculation. waypoint for re-calculating that you used for the initial calculation.
This way you can follow a long distance route via the _service interface_, This way you can follow a long distance route via the _service interface_,

5
docs/users/android_quickstart.md
View File

@ -8,7 +8,7 @@ nav_order: 1
### Choosing and installing a map tool ### Choosing and installing a map tool
BRouter just calculates tracks as GPX or GeoJSON files. It does not display maps BRouter just calculates tracks as GPX or GeoJSON files. It does not display maps
or give any navigation instuctions. Therefore you need a map-tool in order for or give any navigation instructions. Therefore you need a map-tool in order for
BRouter to be useful. BRouter to be useful.
Several map tools support routing with BRouter: Several map tools support routing with BRouter:
@ -44,7 +44,6 @@ Since Android 11 apps can only write to their app-specific storage so BRouter
can only use `<...>/Android/media/btools.routingapp/` as base directory. The can only use `<...>/Android/media/btools.routingapp/` as base directory. The
app-specific storage can be located on internal or external storage. app-specific storage can be located on internal or external storage.
### Download routing segments ### Download routing segments
BRouter requires routing data which is independent of the displayed map of a map BRouter requires routing data which is independent of the displayed map of a map
@ -67,7 +66,7 @@ BRouter as navigation service.
Note: OsmAnd only displays BRouter as navigation service if BRouter is Note: OsmAnd only displays BRouter as navigation service if BRouter is
installed. You have to install BRouter before configuring OsmAnd. installed. You have to install BRouter before configuring OsmAnd.
The _service interface_ allows specifing either a _routing-mode_ (used by OsmAnd The _service interface_ allows specifying either a _routing-mode_ (used by OsmAnd
and OruxMaps) or a _routing-profile_ (used by LocusMap). When using a and OruxMaps) or a _routing-profile_ (used by LocusMap). When using a
_routing-mode_ BRouter selects the _routing-profile_ according to a mapping. _routing-mode_ BRouter selects the _routing-profile_ according to a mapping.