Studierende müssen im Rahmen ihrer Projekt- oder Abschlussarbeit sämtliche Ergebnisse betreffend Software, Quellcode und ROS-Pakete in ein speziell dafür vorgesehenes Repository (Repo) hochladen sowie einen unterstützenden Readme erstellen. Diese soll als Einseiter formuliert und Leserinnen und Leser die wichtigsten Aspekte der erzeugten Lösung möglichst kurz und prägnant erläutern. Weitere Hinweise:
Muster für Abgaben:
Projekttitel:
Titel der Arbeit, Name des Erzeugers, Datum der letzten Änderung
Beschreibung:
Eine gute Beschreibung ist klar, kurz und bringt das wesentlichste auf den Punkt. Außerdem wird die Relevanz des Projekts beleuchtet.
Voraussetzungen
Alles was für die Arbeit vorausgesetzt wird, soll hier erwähnt werden. Z.B. Programme die genutzt werden und vorher installiert und eingerichtet werden müssen.
Installation:
Ein guter Wiki-Beitrag erläutert die Installation des Repos auf dem lokalen Rechner. Dazu werden Befehlszeilen als Code formatiert, um zwischen Text und Befehlen zu unterscheiden.
Anwendung:
Anleitung zur Inbetriebnahme des Projekts nach der Installation. Befehlszeilen werden als Code formatiert (Bilder unterstützender Natur erwünscht).
Erläuterung:
Funktion und Aufbau wesentlichster Programme sollen besprochen werden. Somit kann der Benutzer im Anschluss auch Änderungen vornehmen.
Anmerkungen:
Sonstige Anmerkungen bzw. Informationen können hier erwähnt werden.
Quellen:
Hier wird auf weitere Projekte verwiesen, auf die diese Arbeit aufbaut.