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

Misc updates to the README #5526

Merged
merged 7 commits into from
Jun 23, 2021
Merged

Misc updates to the README #5526

merged 7 commits into from
Jun 23, 2021

Conversation

clintoncwolfe
Copy link
Contributor

Description

Misc updates to the README

Related Issue

Fixes #5110

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New content (non-breaking change)
  • Breaking change (a content change which would break existing functionality or processes)

Checklist:

  • I have read the CONTRIBUTING document.

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
@clintoncwolfe clintoncwolfe requested review from a team as code owners May 16, 2021 21:57
@netlify
Copy link

netlify bot commented May 16, 2021

✔️ Deploy Preview for chef-inspec ready!

🔨 Explore the source changes: 583267f

🔍 Inspect the deploy log: https://app.netlify.com/sites/chef-inspec/deploys/60d38e24d9373600080b8de7

😎 Browse the preview: https://deploy-preview-5526--chef-inspec.netlify.app

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated
@@ -78,7 +78,9 @@ curl https://omnitruck.chef.io/install.sh | sudo bash -s -- -P inspec

### Install it via rubygems.org

When installing from source, gem dependencies may require ruby build tools to be installed.
When installing from source, gem dependencies may require ruby build tools to be installed. (A compiler-free variant is available with reduced functionality; use `inspec-core-bin` and `inspec-core`.)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When installing from source, gem dependencies may require ruby build tools to be installed. (A compiler-free variant is available with reduced functionality; use `inspec-core-bin` and `inspec-core`.)
Installing the Chef InSpec package from source may require installing ruby build tools to manage gem dependencies. (A compiler-free variant is available with reduced functionality; use `inspec-core-bin` and `inspec-core`.)

Changes for active voice.
I'm not sure about word 'manage' and I'm open to suggestions. Handle? Build?

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
@clintoncwolfe clintoncwolfe merged commit 4df2f20 into master Jun 23, 2021
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 this pull request may close these issues.

Update README
3 participants