lnav icon indicating copy to clipboard operation
lnav copied to clipboard
verified publisher icon tstack

README out of sync with README.md

Open aspiers opened this issue 8 years ago • 0 comments

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:

  1. scrap README, or
  2. tweak Makefile.am so that README is auto-generated from README.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.

aspiers avatar Apr 19 '17 10:04 aspiers