From 0510b427a566a1c55ef0c5271b60fe1dce30229a Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Thu, 23 Jul 2020 23:38:25 -0700 Subject: Readme updates Signed-off-by: Tim Smith --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5175b1d8..80b9c9c3 100644 --- a/README.md +++ b/README.md @@ -18,14 +18,14 @@ Ohai will print out a JSON data blob for all the known data about your system. W Chef distributes ohai as a RubyGem. This README is for developers who want to modify the Ohai source code. For users who want to write plugins for Ohai, see the docs: -- General documentation: -- Writing Ohai Plugins documentation: +- General documentation: +- Writing Ohai Plugins documentation: -## Development Environment: +## Development Environment Ohai's development dependencies should be installed with bundler. Just run `bundle install` in the root of the repo. -## Spec Testing: +## Spec Testing We use RSpec for unit/spec tests. To run the full suite, run: @@ -39,7 +39,7 @@ You can run individual test files by running the rspec executable: bundle exec rspec spec/unit/FILE.rb ``` -## Style: +## Style We use [Chefstyle](https://github.com/chef/chefstyle), as a code [linter](https://en.wikipedia.org/wiki/Lint_(software)), to enforce style guidelines. To run: @@ -73,7 +73,7 @@ rake style:auto_correct # Auto-correct RuboCop offenses ($VERSION is the current version, from the GemSpec in Rakefile) ``` -## Links: +## Links Source: @@ -100,7 +100,7 @@ For information on contributing to this project see