it-swarm.com.de

Readme.txt vs. README.txt

Ich habe gerade ein Projekt in Github gegabelt, meine Änderungen vorgenommen usw. Dies hat mich gefragt: Ich sehe hauptsächlich README.txt in OpenSource-Projekten und die Datei, die ich bearbeitet habe, war Readme.txt. Ist das eine Art Standardisierung oder hätte ich es so lassen sollen, wie es ist?

35
Tolga Ozses

Großbuchstaben fallen auf und machen die Datei leicht sichtbar, was sinnvoll ist, da dies wahrscheinlich das erste ist, was ein neuer Benutzer sehen möchte. (Oder zumindest hätte anschauen sollen ...) Wie andere bereits gesagt haben, werden Dateinamen, die mit einem Großbuchstaben beginnen, vor Kleinbuchstaben aufgeführt Namen in ASCIIbetical Sortierung (LC_COLLATE=C), wodurch die Datei auf den ersten Blick sichtbar wird.

Die Datei README ist Teil einer Reihe von Dateien, die ein Benutzer eines kostenlosen Softwarepakets normalerweise erwarten würde. Andere sind INSTALL (Anweisungen zum Erstellen und Installieren der Software), AUTHORS (Liste der Mitwirkenden), COPYING (Lizenztext), HACKING (Gewusst wie) Erste Schritte für Beiträge, möglicherweise einschließlich einer TODO-Liste von Startpunkten), NEWS (letzte Änderungen) oder ChangeLog (meistens redundant mit Versionskontrollsystemen).

Dies ist, was die GNU-Codierungsstandards über die Datei README zu sagen haben.

Die Distribution sollte eine Datei mit dem Namen README mit einem allgemeinen Überblick über das Paket enthalten:

  • den Namen des Pakets;
  • die Versionsnummer des Pakets oder geben Sie an, wo sich die Version im Paket befindet;
  • eine allgemeine Beschreibung der Funktionsweise des Pakets;
  • einen Verweis auf die Datei INSTALL, die wiederum eine Erläuterung des Installationsvorgangs enthalten sollte;
  • eine kurze Erklärung ungewöhnlicher Verzeichnisse oder Dateien der obersten Ebene oder andere Hinweise für Leser, um sich in der Quelle zurechtzufinden;
  • ein Verweis auf die Datei, die die Kopierbedingungen enthält. Die GNU GPL, falls verwendet, sollte sich in einer Datei mit dem Namen COPYING befinden. Wenn die GNU LGPL verwendet wird, sollte sie sich in einer befinden Datei namens COPYING.LESSER.

Da es immer gut ist, die geringste Überraschung Ihrer Benutzer anzustreben, sollten Sie diese Konvention befolgen, es sei denn, es gibt zwingende Gründe für eine Abweichung. In der UNIX-Welt wurden Dateinamenerweiterungen traditionell sparsam verwendet, sodass der kanonische Name der Datei README ohne Suffix lautet. Aber die meisten Benutzer würden wahrscheinlich keine Probleme haben zu verstehen, dass eine Datei mit dem Namen README.txt hat die gleiche Bedeutung. Wenn die Datei in Markdown geschrieben ist, wird ein Dateiname wie README.md könnte auch vernünftig sein. Vermeiden Sie jedoch die Verwendung komplizierterer Markup-Sprachen wie HTML in der Datei README, da das Lesen auf einem Nur-Text-Terminal bequem sein sollte. Sie können Benutzer auf das Handbuch der Software oder deren Online-Dokumentation verweisen, die möglicherweise in einem komplexeren Format verfasst ist, um Details aus der Datei README zu erhalten.

31
5gon12eder

Traditionell hieß die Datei README in Großbuchstaben, da Befehlszeilenumgebungen mit alphabetischer Reihenfolge die Datei dann oben platzieren würden. Dadurch sind sie in großen Verzeichnissen leicht sichtbar.

Es ist höchstwahrscheinlich ein Überbleibsel aus der Unix/Linux-Welt, wo Sie Quellen herunterladen und dann Ihre Software erstellen würden. Wenn Sie Dateien wie README und INSTALL oben in Ihrer Ansicht "Listenverzeichnisinhalt" haben, können Sie leichter erkennen, dass sie vorhanden sind, anstatt den gesamten Inhalt über eine Befehlszeilenschnittstelle durchsuchen zu müssen Das gleiche Grundprinzip funktioniert auch für Github (und funktioniert tatsächlich auch in GUI-Schnittstellen.

Auf keinen Fall eine harte Regel, aber sehr wahrscheinlich etwas, das jeder aus Gewohnheit tut, weil andere Projekte es tun. Sofern es keinen expliziten Grund gibt, dies NICHT zu tun, sollten Sie wahrscheinlich alle Großbuchstaben verwenden, nur weil Sie sehen, dass es in vielen anderen Projekten auf diese Weise verwendet wird. Dies ist auch die Standardbenennung, die Github verwendet, wenn Sie ein neues Repository erstellen.

20
JDT

README wird normalerweise in Großbuchstaben geschrieben. Auf diese Weise platzierte der Befehl ls Unix die Datei am Anfang der Verzeichnisliste (Großbuchstaben stehen vor Kleinbuchstaben in ASCII Reihenfolge).

6
manlio