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

Document the possible need to install shellcheck #148

Open
arvoelke opened this issue Mar 8, 2021 · 0 comments
Open

Document the possible need to install shellcheck #148

arvoelke opened this issue Mar 8, 2021 · 0 comments

Comments

@arvoelke
Copy link
Contributor

arvoelke commented Mar 8, 2021

In order to run the static script locally I needed to first sudo apt-get install shellcheck (on Ubuntu 18.04.3 LTS). This was a little confusing to me as I thought this was a missing pip package, while I had already tried .ci/static.sh install and couldn't find any mention of spellcheck in the doc search.

A good place to document this might be on the intro page under a new section titled something like "Local usage". This new section would be a good place to include some commonly-used commands such as:

bones-generate --output-dir .ci ci-scripts && .ci/static.sh script
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant