diff --git a/docs/developers/algorithm.md b/docs/developers/algorithm.md index fc123e8..230e0f5 100644 --- a/docs/developers/algorithm.md +++ b/docs/developers/algorithm.md @@ -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 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 -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. 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 -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 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, 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*. diff --git a/docs/developers/android_service.md b/docs/developers/android_service.md index cd45a5e..88ea3d3 100644 --- a/docs/developers/android_service.md +++ b/docs/developers/android_service.md @@ -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. 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. Now you could do that with an calling app. diff --git a/docs/features/vianogo.md b/docs/features/vianogo.md index 8d00d06..1b98553 100644 --- a/docs/features/vianogo.md +++ b/docs/features/vianogo.md @@ -7,10 +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. -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 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 the README for details. diff --git a/docs/privacy_policy.md b/docs/privacy_policy.md index d48a06f..1088d08 100644 --- a/docs/privacy_policy.md +++ b/docs/privacy_policy.md @@ -16,7 +16,6 @@ ## Contact -Get in contact to the delevoper team via Github +Get in contact to the developer team via Github https://github.com/abrensch/brouter - diff --git a/docs/revisions.md b/docs/revisions.md index 70197be..58cf62e 100644 --- a/docs/revisions.md +++ b/docs/revisions.md @@ -69,32 +69,31 @@ Android ### [brouter-1.7.3.zip](../brouter_bin/brouter-1.7.3.zip) (19.08.2023) -- Minor bug fixes - +- Minor bug fixes ### [brouter-1.7.2.zip](../brouter_bin/brouter-1.7.2.zip) (19.07.2023) -- 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. - +- 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. ### [brouter-1.7.1.zip](../brouter_bin/brouter-1.7.1.zip) (12.07.2023) Android -- Add parameter dialog for profile -- Add portrait mode for download view -- Add silent mode for calling apps -- Fixed download lookups.dat when download only single rd5 tile. - +- Add parameter dialog for profile +- Add portrait mode for download view +- Add silent mode for calling apps +- Fixed download lookups.dat when download only single rd5 tile. Library -- Update matching points rules on areas with longer distances between way points -- Optimize constant expressions in profile parsing -- Rework on roundabouts (left-hand driving) -- Add new function 'get elevation' -- Minor bug fixes +- Update matching points rules on areas with longer distances between way points +- Optimize constant expressions in profile parsing +- Rework on roundabouts (left-hand driving) +- Add new function 'get elevation' +- Minor bug fixes ### [brouter-1.7.0.zip](../brouter_bin/brouter-1.7.0.zip) (29.04.2023) @@ -191,7 +190,7 @@ Library - performance improvements - Bicycle+Foot ETA (estimated time of arrival) - ETA data in GPX for Locus + OsmAnd -- more precice distance calculation +- more precise distance calculation - weighted nogos - BRouter-Web related additions - maxspeed:forrward/backward @@ -255,7 +254,7 @@ Library - filtering out unused way tags to increase profile cache efficiency - cache sizing depending on android memory class - 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) @@ -267,16 +266,16 @@ Library ### [brouter_1_4_3.zip](../brouter_bin/brouter_1_4_3.zip) (06.08.2016) - 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 ### [brouter_1_4_2.zip](../brouter_bin/brouter_1_4_2.zip) (16.05.2016) - 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 -### [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 - added xor, lesser, sub operators for profiles @@ -350,12 +349,12 @@ Library - special, fast handling for trivial recalculations for timeout-free recalculations - 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 - around the kitkat (Android 4.4) issues +- added more [configuration options](https://brouter.de/brouter/kitkat_survival_readme.txt) + 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) -- new (google-play compatible) signing key, UNINSTALL NECCESSARY! +- new (google-play compatible) signing key, UNINSTALL NECESSARY! - added crc checksums to datafiles - fixed a bug in accessing the last 64k of a datafile - 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 stores veto-list) - 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 maptool installed - 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) -- some performance improvments +- some performance improvements - support for car-subset datafiles - timeout-free partial recalcs in service-mode - added java-version (executable jar) to distribution zip diff --git a/docs/users/android_advanced.md b/docs/users/android_advanced.md index d421334..7f9473b 100644 --- a/docs/users/android_advanced.md +++ b/docs/users/android_advanced.md @@ -43,7 +43,7 @@ _routing-profile_. #### 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. * `secondary_segment_dir` points to an additional directory containing routing @@ -86,8 +86,8 @@ personal routing preferences. ## Routing via _file interface_ 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 -within the 60 seconds timout if calculated via the _service interface_. +preferred option when calculating long-distance-routes that would not finish +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 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 waypoints. -If a route is calculated, it is stored as `brouter0.gpx`. BRouter stores the route in -`/import/tracks` directory. If started once more with identical input, -BRouter will store a second route `brouter1.gpx` for the first alternative and so on. +If a route is calculated, it is stored as `brouter0.gpx`. BRouter stores the +route in `/import/tracks` directory. If started once more with +identical input, BRouter will store a second route `brouter1.gpx` for the first +alternative and so on. ## 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 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 -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. This way you can follow a long distance route via the _service interface_, diff --git a/docs/users/android_quickstart.md b/docs/users/android_quickstart.md index 50c1830..9b5aa09 100644 --- a/docs/users/android_quickstart.md +++ b/docs/users/android_quickstart.md @@ -8,7 +8,7 @@ nav_order: 1 ### Choosing and installing a map tool 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. 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 app-specific storage can be located on internal or external storage. - ### Download routing segments 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 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 _routing-mode_ BRouter selects the _routing-profile_ according to a mapping.