-
-
Notifications
You must be signed in to change notification settings - Fork 357
Open
Labels
Description
I just noticed the repo has both a README and a README.md, and they are not in sync. So I would suggest to ensure that README.md
has everything which is in README
, and then either:
- scrap
README
, or - tweak
Makefile.am
so thatREADME
is auto-generated fromREADME.md
via a Markdown renderer.
The second option has the disadvantage of introducing an extra build-time dependency, and given that Markdown was deliberately designed to be a nice human-readable format, I'm not sure it's worth having a plain-text README
at all. So personally I think the first option is better, but it's up to you.
Either way, I'm willing to do the work if you let me know what you prefer!
Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.