Skip to content

accefa/doku

Repository files navigation

Projektdokumentation

Dieses Repo beinhaltet die Projektdokumentation des PREN1.

Wichtige Hinweise zur Arbeit an der Projektdokumentation

  • wenn möglich immer mit Issues arbeiten (verhindert Konflikte)
  • Binärdaten generell nicht einbeziehen ins Repo (siehe .gitignore)
  • falls Probleme mit LaTeX auftauchen
    • kurz googeln
    • nicht zu lange debuggen (manche Fehlermeldungen sind nicht eindeutig für Beginner)
    • einfach ninux fragen
  • Bilder falls möglich als Vektorgrafiken erstellen und Export erstellen in PDF (siehe Inkscape)

Repo-Struktur

Das Repo besteht aus einem einfachen und flachen Verzeichnisbaum:

  • Lizenzbeschreibung
  • README Datei
  • tex - Verzeichnis für sämtliche TeX Dateien
    • layout.sty - Layout-Definitionen
    • contents.tex - Inhaltsstruktur
  • fig - Verzeichnis für sämtliche Grafiken
  • pm - Verzeichnis für das Projektmamagement
  • .gitignore

Beispieldokumentationen