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

10
docs/developers/android_service.md Normal file
View file

@ -0,0 +1,10 @@
---
parent: Developers
---
# 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 `IBRouterService.aidl` for
the interface definition.

1
docs/developers/build_segments.md
View file

@ -1,5 +1,6 @@
---
parent: Developers
title: Build segment files
---
Build your own segments files

16
docs/developers/http_server.md Normal file
View file

@ -0,0 +1,16 @@
---
parent: Developers
title: HTTP server
---
# 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
`ServerHandler.java`

21
docs/developers/index.md
View file

@ -22,24 +22,3 @@ 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.