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

Examples require CLI to be installed globally #334

Open
aciccarello opened this issue Aug 23, 2018 · 0 comments
Open

Examples require CLI to be installed globally #334

aciccarello opened this issue Aug 23, 2018 · 0 comments

Comments

@aciccarello
Copy link

Problem

The example READMEs are currently written with the expectation that @dojo/cil is installed globally. Some of the READMEs explicitly state this and others don't. Some of the READMEs say to run an npm script such as npm run dev without a dev dependency on the CLI and without instructions on installing the CLI.

Recommendation

Update the examples to include npm scripts for the primary run commands and add the CLI as a dev dependency. If additional CLI commands are referenced, instructions should be given for how to install the CLI.

Alternate Recommendation

Update all the READMEs to explicitly state that the CLI is required and add install instructions.

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

Successfully merging a pull request may close this issue.

1 participant