refactor: move documentation guide to main README.md

Signed-off-by: Felix Hilgers <[email protected]>
amosproj · Nov 13, 2024 · c451207 · c451207
1 parent e2306ab
commit c451207
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 18 deletions.
diff --git a/Documentation/README.md b/Documentation/README.md
diff --git a/README.md b/README.md
@@ -38,6 +38,15 @@ Installing nix and using the development shell is the recommended approach for d
 
 [^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.
 
+## Documentation
+
+To generate the html documentation run the following:
+
+```
+asciidoctor -r asciidoctor-diagram Documentation/asciidoc/main.adoc -o Documentation/build/doc/index.html
+```
+
+
 ## License
 
 This project adheres to the [reuse](https://reuse.software/) Software recommendations. 
@@ -49,4 +58,5 @@ When adding a new file you have to add yourself to the list of Copyright holders
 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.
+To check whether you have done everything correctly, execute `reuse lint` in the project root directory.
+