summaryrefslogtreecommitdiffstats
path: root/documentation/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/README.md')
-rw-r--r--documentation/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/documentation/README.md b/documentation/README.md
new file mode 100644
index 0000000..71fd20a
--- /dev/null
+++ b/documentation/README.md
@@ -0,0 +1,22 @@
+---
+home: true
+heroImage: /img/logo-light.svg
+actionText: Get Started →
+actionLink: /api/
+footer: Albert-Ludwigs-Universität Freiburg | Copyright © 2019
+---
+
+<div class="features">
+ <div class="feature">
+ <a href="/installation/"><h2>Installation</h2></a>
+ <p>A guide on how to install and run the BAS.</p>
+ </div>
+ <div class="feature">
+ <a href="/api/"><h2>API</h2></a>
+ <p>Documentation of the API and instructions on how to use it.</p>
+ </div>
+ <div class="feature">
+ <a href="/webapp/"><h2>Webapp</h2></a>
+ <p>Picture guided instructions on how the webapp works.</p>
+ </div>
+</div> \ No newline at end of file