CTAN
Comprehensive TeX Archive Network

Help

Which readme file is dis­played in the CTAN browser di­rectly?

The pack­age folder in the CTAN browser im­me­di­ately dis­plays some text in­for­ma­tion about the cur­rent di­rec­tory. This in­for­ma­tion has to be pro­vided by the pack­age au­thor. The por­tal looks for cer­tain files and in­cludes the first one found – de­pend­ing on their type:

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

Note that the readme files with any­thing but up­per-case base names are dis­played for his­tor­i­cal pack­ages. They are not ac­cepted for new sub­mis­sions.

Type TEXT

The type TEXT is ren­dered as em­bed­ded pre-for­mat­ted text. The line breaks are left un­touched. The char­ac­ter are es­caped – if nec­es­sary – to be dis­played prop­erly.

Type MARKDOWN

The text is in­ter­preted ac­cord­ing to the CTAN mark­down rules. Th­ese rules are a vari­ant of Github-flavoured mark­down. They de­ter­mine how a text file can be ren­dered nicely from the read­able text source.

Guest Book Sitemap Contact Contact Author