Git aufräumen und ReadMe schreiben

Nachdem alle wichtigen Dateien in die Repository gepusht wurden, fingen das schreiben der ReadMe an. Dies ist eine Anleitung zur Inbetriebnahme des Projekts, die beschreibt, welche Teile man braucht, welche Dinge installiert werden müssen und eine Beschreibung der genutzten Technologien, was in diesem Fall die Auflistung der genutzten C++ Librarys und deren Version war.

Als die Anleitung fertig geschrieben war, ging es an das Aufräumen der Repository. Dies bestand daraus, die ReadMe auf Fehler zu Überprüfen, bereits gepushte Dateien in sinnvolle Ordner zu packen und den Code auf vernünftige Kommentare zu prüfen. Außerdem war es gerade in diesem Fall wichtig den Code darauf zu überprüfen, ob noch private Daten, wie z.B. das Passwort des eigenen Netzwerkes im Code sind, da mit IoT Technologien gearbeitet wurde.

Leave a Reply

Your email address will not be published. Required fields are marked *

*