Convert README to md and update dev instructions

* Purge wiki references, links to new docs site instead
* Update dev instructions for bundler.

1 files changed, 93 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..b25a0ff5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,93 @@
+# ohai
+
+# DESCRIPTION:
+
+Ohai detects data about your operating system. It can be used
+standalone, but it's 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.
+
+Opscode 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: http://docs.opscode.com/ohai.html
+* Custom plugin documentation: http://docs.opscode.com/ohai_custom.html
+
+# DEVELOPMENT:
+
+Before working on the code, if you plan to contribute your changes, you
+need to read the Opscode Contributing document:
+
+* http://docs.opscode.com/community_contributions.html
+
+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.
+
+## Spec Testing:
+
+We use RSpec for unit/spec tests. To run the full suite, run:
+
+    bundle exec rake spec
+
+You can run individual test files by running the rspec executable:
+
+    bundle exec rspec spec/unit/FILE.rb
+
+## Rake Tasks
+
+Ohai has some Rake tasks for doing various things.
+
+    rake -T
+    rake clobber_package  # Remove package products
+    rake gem              # Build the gem file ohai-$VERSION.gem
+    rake install          # install the gem locally
+    rake make_spec        # create a gemspec file
+    rake package          # Build all the packages
+    rake repackage        # Force a rebuild of the package files
+    rake spec             # Run specs
+  
+    ($VERSION is the current version, from the GemSpec in Rakefile)
+
+# LINKS:
+
+Source:
+
+* http://github.com/opscode/ohai/tree/master
+
+Tickets/Issues:
+
+* http://tickets.opscode.com/
+
+(Use the OHAI project)
+
+# LICENSE:
+
+Ohai - system information application
+
+Author:: Adam Jacob (<adam@opscode.com>)
+Copyright:: Copyright (c) 2008 Opscode, Inc.
+License:: Apache License, Version 2.0
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.