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.

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

Describe requirements in the README #38

Open
machawk1 opened this issue Dec 6, 2018 · 1 comment
Open

Describe requirements in the README #38

machawk1 opened this issue Dec 6, 2018 · 1 comment

Comments

@machawk1
Copy link
Collaborator

machawk1 commented Dec 6, 2018

Are you submitting a bug report or a feature request?

Feature request/documentation enhancement

What is the current behavior?

The requirements for a user to get up and running are insufficient with regard to the requirements and dependencies. I encountered this experience when trying to resolve #31 on a fresh Win10 VM with the Linux extensions. npm is not installed by default. The recommendation is to use the bootstrap script, which relies on npm and git. I know how to resolve this but this barrier may cause some users to give up.

What is the expected behavior?

Provide all information for the user to get going. Maybe have a setup section at the top level of the readme at the same scope of Usage with some more details to help potential users get going.

What's your environment?

Win10 (for this test)

@machawk1
Copy link
Collaborator Author

machawk1 commented Dec 6, 2018

I noticed that the Quick Start section in the Manual mentions node as a requirement but the README does not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant