Help on CTAN

Which readme file is displayed in the CTAN browser directly?

The package folder in the CTAN browser immediately displays some text information about the current directory. This information has to be provided by the package author. The portal looks for certain files and includes the first one found – depending on their type:

Note that the readme files with anything but upper-case base names are displayed for historical packages. They are not accepted for new submissions.

Type TEXT

The type TEXT is rendered as embedded pre-formatted text. The line breaks are left untouched. The character are escaped – if necessary – to be displayed properly.

Type MARKDOWN

The text is interpreted according to the CTAN markdown rules. These rules are a variant of Github-flavoured markdown. They determine how a text file can be rendered nicely from the readable text source.