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

Update the documentation to make it easier for people to understand this project #54

Open
TobyHFerguson opened this issue May 14, 2018 · 0 comments
Open

Update the documentation to make it easier for people to understand this project #54

TobyHFerguson opened this issue May 14, 2018 · 0 comments

Comments

@TobyHFerguson
Copy link
Owner

Few people have just cloned this project and got it to work. I believe that's because the README is too sense - they just gloss over it and never get to grips with what they've got to do.

I propose dramatically shortening the README and replacing it with a wiki page that describes the steps etc. in a more easily consumed fashion.
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
@TobyHFerguson