Zum Inhalt springen
sw
en

Tippe um zu suchen

Software

README / LIESMICH, warum das existiert

Das kleine Textfile, das jeder ignoriert. Und das 90 % aller Fragen beantwortet.

1 Min Lesezeit Zuletzt aktualisiert:

Wenn du neue Software, eine Mod, ein Tool oder einen Download öffnest und eine Datei wie README.txt, LIESMICH.txt, README.md, INSTALL.txt oder HOWTO.txt siehst: LIES DAS ZUERST. Nicht nach 3 Stunden frustriertem Rumklicken.

Was steht da drin?

  • Installationsanleitung: wohin kopieren, welche Reihenfolge
  • Systemanforderungen: was muss schon installiert sein (z. B. .NET, Java, VC++ Redistributables)
  • Bekannte Probleme: „Known Issues”
  • Konfiguration: welche Datei editieren
  • Changelog: was ist neu, was wurde gefixt
  • Lizenz & Kontakt: wer hat’s gebaut

Typische Ordnerstruktur

MeinTool-v2.4.1/
├── README.md         ← IMMER zuerst lesen
├── LICENSE.txt       ← Rechtliches
├── CHANGELOG.md      ← Was hat sich geändert
├── MeinTool.exe      ← Die Hauptanwendung
├── config.ini        ← Einstellungen
└── docs/
    └── INSTALL.md    ← Detaillierte Anleitung

Kommentare

Frage, Verbesserungsvorschlag oder eigene Erfahrung zu diesem Artikel? Schreib einen Kommentar. Neue Beiträge erscheinen nach kurzer Moderation.

  • Lade Kommentare …
Kommentar schreiben