Allow readme.md as well as readme.txt

[joostdevalk]

Right now readme files always have to be .txt files. They're parsed, however, as markdown, and those of us maintaining our plugins on Github usually have a readme.md for GitHub. I think it'd make the most sense to allow plugins to have a readme.md file instead of a readme.txt file, so we don't need to maintain two.

My preference would be that if both exist, the .txt gets read, and otherwise the .md.

Would be happy to write the patch if someone points me in the right direction of where to find the source :)

[dd32]

For the most part, I believe the code is still very close to ​http://plugins-svn.bbpress.org/svn-browser/trunk/

[joostdevalk]

Parser patch

[joostdevalk]

Validator patch

[joostdevalk]

Hmm then I'm guessing it could be as easy as this.

[Otto42]

Github's flavor of markdown is very different than ours. In order for this to work, those differences would need to be outlined and handled by the parser appropriately. I don't think it'd be as easy as simply allowing a different filename.

[joostdevalk]

If I figure out the differences and write the patch you'll accept it though? And can I just patch the SVN browser indeed?

[Otto42]

This was actually added 9 months ago, in [dotorg:9654].

Note that the format for both files is identical. If the readme.md exists, and readme.txt does not, then the readme.md will be used. Additionally, the readme.md is renamed to readme.txt before the official ZIP is built and released to sites.

There are no plans to support GitHub flavored markdown. For this reason, we continue to recommend using the name "readme.txt" and not "readme.md", as they are unlikely to be of the same format. Additionally, GitHub uses the readme.md for entirely different purposes than the plugin directory does.

[SergeyBiryukov]

#4962 was marked as a duplicate.