Projektbeschreibung
Für die Beschreibung des Projektes bitte folgendes Beispielprojekt beachten: meddoser-medikationsplan-auf-dem-raspberry-pi
Gemeinsames Kompilieren und (Kurz-) Anleitung in README
- Das gemeinsame Kompilieren der Software ist im Labor nötig und wird hier durchgeführt
- Die Anleitung im README sollte folgendes enthalten
-
- Kurzbeschreibung des Projektes (Was, Warum, Wie wurde entwickelt? etc.)
- Wichtigste Features der Anwendung
- Liste der Hardware / Software (z. B. Programmiersprache inklusive Versionen etc.)
- Anleitung für Installation und Kompilieren der Anwendung, VM, etc.
- und entsprechend nachfolgende Parameter und Funktionen (s. nächster Punkt)
- Ausblick (aktueller Stand, offene Punkte und Features)
Wichtige Parameter und Funktionen herausschreiben (in README)
- Was muss wo geändert werden um beispielsweise
- Serveranpassung vorzunehmen
- neue Features zu implementieren
- Datenbankänderung vorzunehmen
- Beschreibung der Struktur, Patterns, Packages, Aufteilung des Codes
Bereitstellen in Gitlab
https://gitlab.oth-regensburg.de
- Repository pflegen und kommentieren
- Unter der Website https://gitignore.io/ kann schnell und einfach der Inhalt für die „.gitignore“-Datei erstellt werden
- Sollte es Probleme mit dem Commiten der „.gitignore“-Datei geben, folgendes beachten: https://stackoverflow.com/questions/7927230/remove-directory-from-remote-repository-after-adding-them-to-gitignore
- Insofern der Projektbericht/Abschlussarbeit relevant für die Weiterentwicklung des Projektes sein sollte, diesen bitte auch auf Gitlab zur Verfügung stellen, allerdings sollten grundsätzlich alle nötigen Informationen im Git-Repo enthalten sein.