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 lacks install instructions #355

Closed
ghost opened this issue Jul 15, 2018 · 3 comments
Closed

README lacks install instructions #355

ghost opened this issue Jul 15, 2018 · 3 comments

Comments

@ghost
Copy link

ghost commented Jul 15, 2018

The README lacks install instructions (unless I am too stupid to find them, which may be the case). Please add them!
@feiskyer
Copy link
Member

The install instructions are included in Documentation. The first step of CLI is installation.

@ghost
Copy link
Author

ghost commented Jul 17, 2018 •
edited by ghost
Loading

It would be helpful to link to them from the README. I don't think I know any bigger GitHub project that doesn't have an Installation section in the main README at all, so I would advise having one (even if it just contains a link to the doc section).

@feiskyer
Copy link
Member

Reasonable. Let me add one in the readme.

@feiskyer feiskyer mentioned this issue Jul 18, 2018
Merged
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
@feiskyer