Added a section on startup in the README.md (#507)

Reworked the index.md
- removed commented out text

Minor restructuring of the README.md

---------

Co-authored-by: Tristan Nolde <tristan.nolde@yahoo.de>
This commit is contained in:
2024-01-03 18:31:01 +01:00
committed by GitHub
parent 6e0247c58c
commit f645e2ec4b
5 changed files with 85 additions and 64 deletions

View File

@ -7,26 +7,6 @@ Das Projekt startete im Sommersemester 2023 und dauerte ein Jahr.
Die Dokumentation ist zwar auf Deutsch, wir steigen aber ein mit der `README.md` und der `CONRIBUTING.md`.
Diese sind, um Industriestandards zu entsprechen, auf Englisch gehalten.
.. On the 9th September 2023 the following current development state has been determined:
.. .. drawio-figure:: project_management/Arch.-Planning.drawio
:format: png
:page-index: 1
.. The target deployment architecture should look as follows:
.. .. drawio-figure:: project_management/Arch.-Planning.drawio
:format: png
:page-index: 2
.. The timeline to reach this goal is:
.. .. drawio-figure:: project_management/Arch.-Planning.drawio
:format: png
:page-index: 3
.. An example diagram
.. include:: ../README.md
:parser: myst_parser.sphinx_
.. include:: ../CONTRIBUTING.md