diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 84 |
1 files changed, 36 insertions, 48 deletions
@@ -1,84 +1,72 @@ # ohai -[](https://travis-ci.org/chef/ohai) -[](https://ci.appveyor.com/project/Chef/ohai/branch/master) -[](https://badge.fury.io/rb/ohai) +[](https://travis-ci.org/chef/ohai) [](https://ci.appveyor.com/project/Chef/ohai/branch/master) [](https://badge.fury.io/rb/ohai) -# DESCRIPTION: +## Description -Ohai detects data about your operating system. It can be used -standalone, but its primary purpose is to provide node data to Chef. +Ohai detects data about your operating system. It can be used standalone, but its primary purpose is to provide node data to Chef. -Ohai will print out a JSON data blob for all the known data about your -system. When used with Chef, that data is reported back via node -attributes. +Ohai will print out a JSON data blob for all the known data about your system. When used with Chef, that data is reported back via node attributes. -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: +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 -* Custom plugin documentation: https://docs.chef.io/ohai_custom.html +- General documentation: <https://docs.chef.io/ohai.html> +- Custom plugin documentation: <https://docs.chef.io/ohai_custom.html> -# DEVELOPMENT: +## Development Environment: -Before working on the code, if you plan to contribute your changes, you -should read the contributing guidelines: - -* https://github.com/chef/ohai/blob/master/CONTRIBUTING.md - -The basic process for contributing is: - -1. Fork this repo on GitHub. -2. Create a feature branch for your work. -3. Make your change, including tests. -4. Submit a pull request. - -# ENVIRONMENT: - -Ohai's development dependencies should be installed with bundler. Just -run `bundle install` in the root of the repo. +Ohai's development dependencies should be installed with bundler. Just run `bundle install` in the root of the repo. ## Spec Testing: We use RSpec for unit/spec tests. To run the full suite, run: - bundle exec rake spec +``` +bundle exec rake spec +``` You can run individual test files by running the rspec executable: - bundle exec rspec spec/unit/FILE.rb +``` +bundle exec rspec spec/unit/FILE.rb +``` ## Rake Tasks Ohai has some Rake tasks for doing various things. - rake -T - rake build # Build the gem file ohai-$VERSION.gem - rake install # install the gem locally - rake install:local # install the gem locally without network access - rake release # Create tag $VERSION, build gem, and push to Rubygems - rake spec # Run RSpec tests - - ($VERSION is the current version, from the GemSpec in Rakefile) +``` +rake -T +rake build # Build the gem file ohai-$VERSION.gem +rake install # install the gem locally +rake install:local # install the gem locally without network access +rake release # Create tag $VERSION, build gem, and push to Rubygems +rake spec # Run RSpec tests + +($VERSION is the current version, from the GemSpec in Rakefile) +``` -# LINKS: +## Links: Source: -* https://github.com/chef/ohai/tree/master +- <https://github.com/chef/ohai/tree/master> Issues: -* https://github.com/chef/ohai/issues +- <https://github.com/chef/ohai/issues> + +## Contributing + +For information on contributing to this project see <https://github.com/chef/chef/blob/master/CONTRIBUTING.md> -# LICENSE: +## License Ohai - system information application -* Author:: Adam Jacob (<adam@chef.io>) -* Copyright:: Copyright (c) 2008-2016 Chef Software, Inc. -* License:: Apache License, Version 2.0 +- Author:: Adam Jacob ([adam@chef.io](mailto:adam@chef.io)) +- Copyright:: Copyright (c) 2008-2016 Chef Software, Inc. +- License:: Apache License, Version 2.0 ```text Licensed under the Apache License, Version 2.0 (the "License"); |