diff --git a/README.adoc b/README.adoc index d8ba97f..8d907fc 100644 --- a/README.adoc +++ b/README.adoc @@ -1,14 +1,17 @@ = AdvLabDB -:source-highlighter: highlight.js -:highlightjs-languages: bash image:https://img.shields.io/badge/code%20style-black-000000.svg[link=https://github.com/psf/black] image:https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336[link=https://pycqa.github.io/isort/] -A database with a web interface for labs. +== About +AdvLabDB is a database with a web interface for labs. -Admins have an interface to manager students, groups, experiments, appointments, marks and analyse data. +// TODO: Screenshots -Assistants have a separate interface to set their marks und schedule appointments with students. +// TODO: Features + +Admins have an interface to manage students, groups, experiments, appointments, marks and analyse data. + +Assistants have a separate interface to set marks and schedule appointments with students. == Status The software is still in beta and under active development. Do not hesitate to open issues! @@ -16,8 +19,8 @@ The software is still in beta and under active development. Do not hesitate to o == Setup To setup a server, see the link:docs/server_setup.adoc[setup documentation]. -== Logs -After setting up a server, logs related to AdvLabDB can be found in the directory `/var/log/advlabdb`. +=== Logs +After setting up a server, logs related to AdvLabDB can be found in the directory `/var/log/advlabdb` on the server. == Known issues * Update scripts are not working.