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

Make the README more inviting to new users #131

Open
banesullivan opened this issue May 21, 2019 · 1 comment
Open

Make the README more inviting to new users #131

banesullivan opened this issue May 21, 2019 · 1 comment

Comments

@banesullivan
Copy link

banesullivan commented May 21, 2019 •
edited

The README for this repository is not very welcoming to new users.

Could you all clean it up and make it human-readable (new-user-readable) in a markup language like Markdown such that it is more inviting to a new user?
@banesullivan
Copy link
Author

There appears to be a lot of extraneous details currently in the README that might be better suited for a documentation website

@banesullivan banesullivan mentioned this issue May 21, 2019
Closed
10 tasks
@banesullivan banesullivan changed the title Make the README human-readable Make the README more inviting to new users May 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@banesullivan