Skip to content

README.txt and README.md #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
micahcochran opened this issue Apr 10, 2016 · 1 comment
Closed

README.txt and README.md #53

micahcochran opened this issue Apr 10, 2016 · 1 comment

Comments

@micahcochran
Copy link
Contributor

Having both of these files causes confusion. They are not kept in sync with one another. For the most part the text version seems to have had some more extensive edits.

The Markdown version can be improved using guidance from the CommonMark spec to be made more readable from a text editor. Also, Markdown can be converted to many formats using pandoc or similar converter.

The doctest seems to work fine with the markdown version, but it does find about 25 fewer tests.

It seems like they were basically the same file on March 11, 2014.

I propose removing README.txt, retargeting the doctest to use README.md, and include changes made to README.txt for inclusion to README.md.

The only issue I can see is that README.txt has release version, author, and release date. This could be maintained in a separate file such as perhaps a RELEASE.txt file.

@micahcochran
Copy link
Contributor Author

Resolved by issue #61 being merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant