Readme.txt vs. README.txt (Deutsch)

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

Die README -Datei 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 (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 die GNU-Codierungsstandards müssen über die Datei README sprechen.

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

• den Namen des Pakets;
• die Versionsnummer des Pakets oder beziehen Sie sich darauf, wo im Paket die Version zu finden ist;
• eine allgemeine Beschreibung der Funktionsweise des Pakets;
• einen Verweis auf die Datei INSTALL, was in tur sein sollte n enthält eine Erläuterung des Installationsvorgangs;
• eine kurze Erläuterung ungewöhnlicher Verzeichnisse oder Dateien der obersten Ebene oder andere Hinweise, damit sich die Leser in der Quelle zurechtfinden;
• a Verweis auf die Datei, die die Kopierbedingungen enthält. Die GNU-GPL sollte sich, falls verwendet, in einer Datei mit dem Namen COPYING befinden. Wenn die GNU LGPL verwendet wird, sollte sie sich in einer Datei mit dem Namen COPYING.LESSER befinden.

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 dieselbe Bedeutung hat. Wenn die Datei in Markdown geschrieben ist, kann auch ein Dateiname wie README.md lauten angemessen. Vermeiden Sie jedoch die Verwendung komplizierterer Auszeichnungssprachen wie HTML in der Datei README, da das Lesen auf einem Nur-Text-Terminal praktisch 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.

Traditionell wurde die Datei in Großbuchstaben README genannt, da Befehlszeilenumgebungen mit alphabetischer Reihenfolge die Datei dann oben platzieren würden. Dies macht sie in großen Verzeichnissen leicht sichtbar.

Es ist höchstwahrscheinlich ein Überbleibsel aus der Unix / Linux-Welt, bei dem Sie Quellen herunterladen und dann Ihre Software erstellen würden. Wenn Sie Dateien wie README und INSTALL oben in Ihrer Ansicht „Listenverzeichnisinhalt“ haben, ist dies der Fall Es ist einfacher zu erkennen, dass sie vorhanden sind, als den gesamten Inhalt über eine Befehlszeilenschnittstelle durchsuchen zu müssen. Das gleiche Grundprinzip gilt auch für Github (und funktioniert auch für GUI-Schnittstellen. Denken Sie darüber nach immer noch Verdienst)

Auf keinen Fall eine harte Regel, aber sehr wahrscheinlich etwas, das jeder aus Gewohnheit tut, weil andere Projekte es tun. Wenn es keinen expliziten Grund gibt, dies NICHT zu tun, sollten Sie wahrscheinlich alle verwenden Kappen, nur weil Sie sehen werden, dass es in vielen anderen Projekten so verwendet wird. Dies ist auch die Standardbezeichnung, die Github beim Erstellen eines neuen Repositorys verwendet.

Kommentare

• I '
• Auf einer Befehlszeilenschnittstelle sind die Dateien, die oben in der Liste angezeigt werden, diejenigen, die zuerst aus der Ansicht gescrollt werden. Manchmal sind dies also die am wenigsten sichtbaren Dateien. Es sei denn, Sie tun immer so etwas wie ls -l | less.

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

Kommentare

• Dies war der historische Grund, aber ls tut dies nicht ' t Normalerweise wird dies auf modernen Systemen so sortiert.
• @ dan1111 Richtig! Vielen Dank (nur um zu versuchen … LC_COLLATE="en_US.ascii" ; ls -l vs LC_COLLATE="en_US.UTF-8" ; ls -l)