CTAN
Comprehensive TeX Archive Network

Hilfe

Welche Readme-Datei wird im CTAN-Browser di­rekt angezeigt?

Der zu einem Paket gehörende Ord­ner im CTAN-Browser zeigt einen Text zu dem ak­tuellen Verze­ich­nis di­rekt an. Diese In­for­ma­tion kann von dem Paket-Au­tor bere­it­gestellt wer­den. Das Por­tal such nach eini­gen Dateien und bet­tet die er­ste, ge­fun­dene Datei ein – ab­hängig von ihrem Typ:

DateinameTyp
README.mdMARKDOWN
README.markdownMARKDOWN
READMETEXT
README.txtTEXT
ReadMe.mdMARKDOWN
ReadMe.markdownMARKDOWN
ReadMeTEXT
ReadMe.txtTEXT
readme.mdMARKDOWN
readme.markdownMARKDOWN
readmeTEXT
readme.txtTEXT
READ.METEXT
read.meTEXT

Man beachte, dass die Readme-Dateien, deren Ba­sis-Name nicht nur aus Großbuch­staben besteht nur für his­torische Pakete angezeigt wer­den. Sie wer­den in neuen Paketen nicht akzep­tiert.

Typ TEXT

Der Typ TEXT wird als einge­bet­tetet, vor­for­matierter Text dargestellt. Die Zeilenum­brüche bleiben dabei un­berührt. Die Ze­ichen wer­den nöti­gen­falls geschützt, um un­verän­dert dargestellt wer­den zu kön­nen.

Typ MARKDOWN

Der Text wird auf Ba­sis der Regeln für CTAN-Mark­down in­ter­pretiert. Diese Regeln sind eine Vari­ante des Github-flavoured mark­down. Sie legen fest, wie eine Text­datei ansprechend dargestellt wer­den kann, wenn man von einem les­baren Quell­text aus­geht.

Gästebuch Seiten-Struktur Impressum Autor kontaktieren