Squidwarc icon indicating copy to clipboard operation
Squidwarc copied to clipboard

Describe requirements in the README

Open machawk1 opened this issue 6 years ago • 1 comments

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 avatar Dec 06 '18 16:12 machawk1

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

machawk1 avatar Dec 06 '18 16:12 machawk1