Closed 0xcaff closed 10 years ago
Don't rename the file - README is a standard name on several platforms & it doesn't need the .md extension for github to render the markdown
I just tested it and the *.md
extension is needed to render the file as markdown. Reference. What platforms are rigidly only searching for README
s instead of anything that matches the Regexp /^readme.*$/i
?
CC: @artart78 @libcg
I'm okay with this pull request. @WinterMute
Renaming the README file doesn't seem to be a big issue, and many projects do it. I think it can be merged safely.
I cleaned up the readme and converted it to markdown.