Home
To get insights into the technical design and architecture of this project, see here.
To learn more about building and deploying, see here.
For user facing documentation, have a look here.
To generate the html documentation run the following:
asciidoctor -r asciidoctor-diagram Documentation/asciidoc/main.adoc -o Documentation/build/doc/index.html
This project adheres to the reuse Software recommendations.
When modifying a file please add yourself to the list of Copyright Holders.
You can do that with reuse annotate --copyright="YOUR NAME <YOUR EMAIL>" FILE.
When adding a new file you have to add yourself to the list of Copyright holders and set the license.
You should prefer the MIT license if possible.
The easiest way to set the license and copyright is to execute reuse annotate --copyright="YOUR NAME <YOUR EMAIL>" --license "MIT" FILE.
To check whether you have done everything correctly, execute reuse lint in the project root directory.
[1]: Android is a trademark of Google LLC. The Android robot is reproduced or modified from work created and shared by Google and used according to terms described in the Creative Commons 3.0 Attribution License.