summaryrefslogtreecommitdiffstats
path: root/documentation/README.md
diff options
context:
space:
mode:
authorJannik Schönartz2019-03-10 04:50:32 +0100
committerJannik Schönartz2019-03-10 04:50:32 +0100
commitdc102d24f0fcb6247388880abc7f3208d0b7a9eb (patch)
treef5c7af2f8cb217488052b71978f45a667d03b363 /documentation/README.md
parent[ipxe] Add parameter to api how many lines the response should send and adjus... (diff)
downloadbas-dc102d24f0fcb6247388880abc7f3208d0b7a9eb.tar.gz
bas-dc102d24f0fcb6247388880abc7f3208d0b7a9eb.tar.xz
bas-dc102d24f0fcb6247388880abc7f3208d0b7a9eb.zip
[documentation] Add documentation site
Override css (Design the topbar & site) <-- A lot of Udo's help Create structure for the differen pages Start writing the installation Write the getting started API site Write documentation of the authentication api Write documentation of the setup api
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