Inhalt

• Schritte
• Tipps
• Was brauchst du

Eine Readme-Datei ist ein kleines Dokument, das normalerweise in einem Programm enthalten ist. Readme-Dateien werden von Softwareentwicklern geschrieben und enthalten grundlegende Informationen zu einem Programm, einschließlich Installationsinformationen oder eine Anleitung zu Systemeinstellungen, Kontaktinformationen, Lizenzen, Empfehlungen und Informationen zur Softwareversion. Für die Softwareverteilung ist es wichtig zu wissen, wie die Readme-Datei geschrieben wird. Eine schlecht geschriebene Readme-Datei kann für den Benutzer frustrierend und ermüdend sein, während eine gute Readme ihnen dabei helfen kann, die grundlegenden Informationen über Ihr Programm leicht zu erlernen.

Schritte

1. 1 Fügen Sie Kontaktinformationen hinzu. Dies ist wahrscheinlich der wichtigste Teil des Readme-Dokuments. Die Kontaktinformationen ermöglichen es dem Benutzer, Sie zu kontaktieren, um Ihnen eine Ergänzung des Programms vorzuschlagen, eine Frage zu stellen, einen Fehler zu korrigieren oder für das Programm zu bezahlen. Geben Sie den Firmennamen, die Website, die E-Mail-Adresse und die Telefonnummer an (diese Informationen werden mehrere Zeilen benötigen).
   • Ein Beispiel ist im Bild gezeigt.
2. 2 Fügen Sie das Datum in Ihre Readme ein. Dies ist ein kleiner, aber sehr wichtiger Schritt. Es ist wichtig, das Verteilungsdatum für Ihr Programm anzugeben. Auf diese Weise werden Benutzer über Aktualisierungen der Programmversion informiert und können auch feststellen, ob sie noch unterstützt werden.
3. 3 Notieren Sie sich den Programmnamen, die Version und die Preisinformationen. Schreiben Sie oben den Anwendungsnamen und die Versionsnummer. Bitte geben Sie den Preis für die Vollversion unten ein. Wenn Sie das Programm über physische Medien wie CDs vertreiben, werden die Preisinformationen möglicherweise nicht angegeben, da Benutzer wahrscheinlich bereits für das Programm bezahlt haben.
4. 4 Beschreiben Sie kurz das Programm. Beschreiben Sie Ihr Programm kurz in ein oder zwei Sätzen. Zum Beispiel: "Diese Anwendung verfolgt die Stimmung des Benutzers, indem sie seine Aktivitäten im Internet analysiert und dann den Platz auf dem Desktop so ändert, dass er sich an den emotionalen Zustand des Benutzers anpasst."
   • Wenn Ihre Software einen ziemlich breiten Funktionsumfang hat, können Sie die Beschreibung um einen oder zwei ganze Absätze erweitern. Sie können eine Liste mit Aufzählungszeichen verwenden, um alle Funktionen und Merkmale des Programms zu nummerieren.
5. 5 Beschreiben Sie die Mindestanforderungen für das Programm. Eine gute Readme-Datei sollte Informationen zu den Mindestanforderungen für das Programm und Anweisungen zur Installation enthalten. Wenn Sie eine andere Software benötigen, um das Programm zu installieren, erwähnen Sie dies unbedingt. Sie können auch Informationen zu empfohlenen Anforderungen (z. B. CPU-Auslastung) angeben.
6. 6 Fügen Sie Lizenz- und Copyright-Informationen hinzu. Vergessen Sie am Ende nicht, Informationen über das Datum der Begründung des Urheberrechts und der Lizenzierung des Programms anzugeben.

Tipps

• Um zu verhindern, dass Benutzer Ihre Datei formatieren müssen, speichern Sie sie im Nur-Text-Format (.txt).
• Fügen Sie in den Namen der Readme-Datei den Namen des Programms ein; Daher sucht der Benutzer nach dem Namen des Programms nach der Readme-Datei.

Was brauchst du

• Computer
• Texteditor