Add content from README

This commit is contained in:
Manuel Fuhr 2021-12-01 07:29:51 +01:00
parent ca30bc86b9
commit 0fba5307fe
2 changed files with 83 additions and 1 deletions

View file

@ -1,5 +1,45 @@
---
title: Developers
has_children: true
nav_order: 3
nav_order: 4
---
# Developer Information
## Profile Development
BRouter offers [freely configurable routing
profiles](../features/costfunctions.md). To extend existing profiles or develop
you own profile see [Profile Developers Guide](profile_developers_guide.md) for
a technical reference.
### (Optional) Generate profile variants
This repository holds examples of BRouter profiles for many different
transportation modes. Most of these can be easily customized by setting
variables in the first `global` context of the profiles files.
An helper script is available in `misc/scripts/generate_profile_variants.sh`
to help you quickly generate variants based on the default profiles, to create
a default set of profiles covering most of the basic use cases.
## 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.
## Android Service
BRouter exposes an [Android
Service](https://developer.android.com/guide/components/services) which can be
used by other applications to calculate routes. See
[`brouter-routing-app/src/main/aidl/btools/routingapp/IBRouterService.aidl`](brouter-routing-app/src/main/aidl/btools/routingapp/IBRouterService.aidl)
for the interface definition.

42
docs/users/index.md Normal file
View file

@ -0,0 +1,42 @@
---
title: Using BRouter
nav_order: 3
---
## Online
Check [brouter-web](https://brouter.de/brouter-web/) or
[bikerouter.de](https://bikerouter.de/) if you want to use BRouter online.
## 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). Older
versions are available in the [revision history](../revisions.md). You can find
detailed documentation of the BRouter Android app in
[`misc/readmes/readme.txt`](misc/readmes/readme.txt).
### Android with Locus
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.
A full documentation on how to set this up is available in the [LocusMap user
manual](https://docs.locusmap.eu/doku.php?id=manual:faq:how_to_navigate_offline).
### Android with OsmAnd
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 in the [OsmAnd feature
description](https://osmand.net/features/navigation-profiles#create_brouter).
## Google group for support questions and feedback
Please use the
[osm-android-bikerouting](http://groups.google.com/group/osm-android-bikerouting)
google group for any questions/feedback.