Skip to content

[skip changelog] Improve the README #525

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 10 commits into from
Dec 20, 2019
Merged

[skip changelog] Improve the README #525

merged 10 commits into from
Dec 20, 2019

Conversation

masci
Copy link
Contributor

@masci masci commented Dec 20, 2019

  • added TOC
  • made more compact
  • added explicit reference to configuration file usage
  • revamped the getting started guide

The format has changed from Markdown to rST to get automatic TOC generation.

preview

@masci masci added the topic: documentation Related to documentation for the project label Dec 20, 2019
rsora
rsora approved these changes Dec 20, 2019
View reviewed changes
Copy link
Contributor

@rsora rsora left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent! 📖

@masci masci merged commit a47c4c9 into master Dec 20, 2019
@masci masci deleted the massi/readme branch December 20, 2019 14:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rsora rsora rsora approved these changes

Assignees
No one assigned
Labels
topic: documentation Related to documentation for the project
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@masci @rsora