README

Ich als Veröffentlichter sollte eine selbstgemachte README im "Root"-Projektverzeichnis haben, damit Interessenten wissen, was und wie sie etwas machen können. Des Weiteren weckt dies einen professionellen und willkommenen Eindruck.

Akzeptanzkriterien:

• alte README.md ist gelöscht
• neue README.md wurde erstellt
• README beinhaltet:
  • Lizenz wird aufgeführt
  • Beschreibung was diese Software macht/wofür sie da ist
  • Überschrift Fast & Easy (oder so ähnlich)
    • Verweis auf die Prev-Domain (siehe Repo Beschreibung)
    • Hinweis auf GitLab Releases (mit Link)
      • es wird beschrieben, dass diese nur heruntergeladen werden müssen (Kompilierung ist für den Endanwender nicht mehr erforderlich)
  • Überschrift Manual Installation / Developer Guide (oder so ähnlich)
    • Hinweis auf yarn als Package Manager (mit Link zu Yarn)
    • Beschreibung zum Ausführen (yarn start)
    • Beschreibung zum Kompilieren (yarn build)
  • Autoren werden aufgelistet (zuerst @leif-kristof.schultz, dann @janne.wernecken)
  • Hochschule wird erwähnt, evtl. auch die Forschungsgruppe