diff options
| author | Tim Smith <tsmith84@gmail.com> | 2020-07-23 23:38:25 -0700 |
|---|---|---|
| committer | Tim Smith <tsmith84@gmail.com> | 2020-07-23 23:39:54 -0700 |
| commit | 0510b427a566a1c55ef0c5271b60fe1dce30229a (patch) | |
| tree | 001fd6cdc0238b06200904cdbd259b7230795808 | |
| parent | 0a6530f2b7fdf225a7ca0ae54459cfce9b8d3b4c (diff) | |
| download | ohai-readme.tar.gz | |
Readme updatesreadme
Signed-off-by: Tim Smith <tsmith@chef.io>
| -rw-r--r-- | README.md | 14 |
1 files changed, 7 insertions, 7 deletions
@@ -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: <https://docs.chef.io/ohai.html> -- Writing Ohai Plugins documentation: <https://docs.chef.io/ohai_custom.html> +- General documentation: <https://docs.chef.io/ohai/> +- Writing Ohai Plugins documentation: <https://docs.chef.io/ohai_custom/> -## 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 <https://github.com/chef/che Ohai - system information application - Author:: Adam Jacob ([adam@chef.io](mailto:adam@chef.io)) -- Copyright:: Copyright (c) 2008-2019 Chef Software, Inc. +- Copyright:: Copyright (c) 2008-2020 Chef Software, Inc. - License:: Apache License, Version 2.0 ```text |