Merge pull request #6 from StudyProject-NLI/documentation

initial mkdocs setup

Author: Maximilian Häming

README.md

@@ -2,7 +2,19 @@
 
 This is the code repository for the Android app developed in the studyproject Sensory augmentation and grasping movements.
 
-![Debug APK Builds](https://github.com/StudyProject-NLI/NLInterface/actions/workflows/main.yml/badge.svg)
+![Debug APK Builds](https://github.com/StudyProject-NLI/NLInterface/actions/workflows/debug_build.yml/badge.svg)
+
+# Documentation
+
+## Running locally
+- Install Python
+- `pip install -r docs/requirements.txt`
+
+Run the documentation server via 
+```bash
+$ mkdocs serve
+```
+
 
 # Building the app locally
 Requirements:
@@ -28,13 +40,3 @@ The resulting installable application can be found under
 `app/build/outputs/apk/debug/app-debug.apk`
 
 which you can copy and install on your device.
-
-
-# Local Development Setup
-
-We are using [Android Studio](https://developer.android.com/studio/) for development.
-
-
-# Architecture Overview
-
-t.b.d

docs/architecture/overview.md

@@ -0,0 +1 @@
+# How is our app structured?

docs/index.md

@@ -0,0 +1,17 @@
+# Overview
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.

docs/requirements.txt

@@ -0,0 +1,2 @@
+mkdocs
+mkdocs-material

mkdocs.yml

@@ -0,0 +1,13 @@
+site_name: NLInterface
+site_url: ""
+use_directory_urls: false
+
+theme:
+  name: "material"
+  highlightjs: true
+  hljs_languages:
+    - bash
+    - kotlin
+
+markdown_extensions:
+  - admonition