Skip to content
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

README: various improvements #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

README: various improvements #2

wants to merge 1 commit into from

Conversation

waldyrious
Copy link

  • format filenames as code
  • highlight data source types as bold, for readability
  • add links to dependencies
  • format sub-headings in "Description of files" section
  • improve line wrapping a bit
  • slightly reword a few passages for additional clarity

@waldyrious
README: various improvements
0719510 
- format filenames as code
- highlight data source types as bold, for readability
- add links to dependencies
- format sub-headings in "Description of files" section
- improve line wrapping a bit
- slightly reword a few passages for additional clarity
@waldyrious
Copy link
Author

waldyrious commented Mar 23, 2018 •
edited
Loading

To be honest, the main reason I even started editing this file was to have a place to express my appreciation for the excellent documentation of this package, especially the flowchart diagram at the end of the README :) It makes it very easy to get a quick overview and to jump in.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@waldyrious