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

Convert README to markdown #15

Merged
merged 1 commit into from Dec 31, 2015

Conversation

Projects
None yet
2 participants
@paultcochrane
Contributor

paultcochrane commented Dec 29, 2015

Also restructure the README to shorten it, to point to the detailed docs in
the code and to give information about installation and dependencies, which
wouldn't be helpful within the in-code documentation.

Since the information in the README is now much reduced and more focussed on a high-level overview of the module, it should be easier to keep this file up to date by hand as opposed to generating the text from the in-code documentation.

Convert README to markdown
Also restructure the README to shorten it, to point to the detailed docs in
the code and to give information about installation and dependencies, which
wouldn't be helpful within the in-code documentation.

mstratman added a commit that referenced this pull request Dec 31, 2015

@mstratman mstratman merged commit 394db18 into mstratman:master Dec 31, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment