Der Readme Generator ist ein kleines Programm für diejenigen, die selber
Programme schreiben, Mods für Spiele entwickeln o.ä.
Mit diesem Tool vereinfacht sich das Schreiben einer Readme Datei um einiges.
Programmiert ist der Readme Generator in C#.
Benötigt wird daher das .NET Framework 4.0 bzw. für Linux / MacOSX Mono 2.8.

Allgemein

Benutzung:
Der Readme Generator bietet Eingabefelder für folgende Informationen:

  • Projekt Name
  • Projekt Seite (Website des Projekts)
  • Autor
  • Projekt Version
  • Copyright
  • Lizenz
  • Kurzbeschreibung
  • Systemanforderungen
  • In- / Deinstallationsanweisungen
  • Changelog

Felder, die nicht gebraucht werden, könnt ihr einfach leer lassen.
Die Felder „Name“, „Autor“, „Version“ und „Copyright“ sind Pflichtfelder.
Wenn ihr nicht genau wisst, was man in die Felder eintragen könnte, klickt im
Hilfe Menu auf „Bearbeiten -> Leere Felder… -> mit Beispielen befüllen“, um alle leeren Felder mit
beispielen auszufüllen.

Habt ihr alle Felder ausgefüllt, könnt ihr eure Readme speichern (z.B. als .txt Datei),
indem ihr auf „Datei -> Speichern unter…“ klickt.

In Version 1.1 ist es nun einfacher, Systemanforderungen hinzuzufügen.
Außerderm ist die gesamte Oberfläche auf Deutsch und das Layout der
Ausgabe – Readmes wurde verbessert.
Ein Credit ist nicht zwingend nötig, allerdings würde ich mich sehr freuen,
wenn ihr dies dennoch tut 😉

Der Readme Generator ist in vollem Funktionsumfang auch in Neo Tools implementiert.

Download: