Permalink
Browse files

[OC-3564] move README to markdown format

  • Loading branch information...
1 parent 7392a73 commit 555b2c1190214639aeea2a395d1f0436203fc037 @schisamo schisamo committed Oct 30, 2012
Showing with 98 additions and 111 deletions.
  1. +5 −1 .gitignore
  2. +1 −0 .yardopts
  3. +89 −0 README.md
  4. +0 −107 README.rdoc
  5. +3 −3 chef.gemspec
View
@@ -1,6 +1,5 @@
.autotest
coverage
-doc
.DS_Store
pkg
*/tags
@@ -21,3 +20,8 @@ binstubs/
# RVM and RBENV ruby version files
.rbenv-version
.rvmrc
+
+# Documentation
+_site/*
+.yardoc/
+doc/
View
@@ -0,0 +1 @@
+-m markdown
View
@@ -0,0 +1,89 @@
+# Chef
+
+* Documentation: [http://wiki.opscode.com/display/chef/Home/](http://wiki.opscode.com/display/chef/Home/)
+* Source: [http://github.com/opscode/chef/tree/master](http://github.com/opscode/chef/tree/master)
+* Tickets/Issues: [http://tickets.opscode.com](http://tickets.opscode.com)
+* IRC: `#chef` and `#chef-hacking` on Freenode
+* Mailing list: [http://lists.opscode.com](http://lists.opscode.com)
+
+Chef is a configuration management tool designed to bring automation to your
+entire infrastructure.
+
+The [Chef Wiki](http://wiki.opscode.com/display/chef/Home) is the definitive
+source of user documentation.
+
+This README focuses on developers who want to modify Chef source code. For
+users who just want to run the latest and greatest Chef development version in
+their environment, see the
+[Installing Chef from HEAD](http://wiki.opscode.com/display/chef/Installing+Chef+from+HEAD)
+page on the wiki.
+
+## Contributing/Development
+
+Before working on the code, if you plan to contribute your changes, you need to
+read the
+[Opscode Contributing document](http://wiki.opscode.com/display/chef/How+to+Contribute).
+
+You will also need to set up the repository with the appropriate branches. We
+document the process on the
+[Working with Git](http://wiki.opscode.com/display/chef/Working+with+git) page
+of the Chef wiki.
+
+Once your repository is set up, you can start working on the code. We do use
+TDD with RSpec, so you'll need to get a development environment running.
+
+### Requirements
+
+Ruby 1.8.7+ (As of 2012-05-25 Ruby 1.8.6 should still work, except for CHEF-2329.)
+
+### Environment
+
+In order to have a development environment where changes to the Chef code can
+be tested, we'll need to install a few things after setting up the Git
+repository.
+
+#### Non-Gem Dependencies
+
+Install these via your platform's preferred method; for example apt, yum,
+ports, emerge, etc.
+
+* [Git](http://git-scm.com/)
+* GCC and C Standard Libraries, header files, etc. (i.e., build-essential on
+debian/ubuntu)
+* Ruby development package
+
+#### Runtime Rubygem Dependencies
+
+First you'll need [bundler](http://github.com/carlhuda/bundler) which can
+be installed with a simple `gem install bundler`. Afterwords, do the following:
+
+ bundle install
+
+## Testing
+
+We use RSpec for unit/spec tests. It is not necessary to start the development
+environment to run the specs--they are completely standalone.
+
+ rake spec
+
+# License
+
+Chef - A configuration management system
+
+| | |
+|:---------------------|:-----------------------------------------|
+| **Author:** | Adam Jacob (<adam@opscode.com>)
+| **Copyright:** | Copyright (c) 2008-2012 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.
View
@@ -1,107 +0,0 @@
-= Chef
-
-== DESCRIPTION:
-
-Chef is a configuration management tool designed to bring automation to your entire infrastructure.
-
-The Chef Wiki is the definitive source of user documentation.
-
-* http://wiki.opscode.com/display/chef/Home
-
-This README focuses on developers who want to modify Chef source code. For users who just want to run the latest and greatest Chef development version in their environment, see:
-
-* http://wiki.opscode.com/display/chef/Installing+Chef+from+HEAD
-
-== DEVELOPMENT:
-
-Before working on the code, if you plan to contribute your changes, you need to read the Opscode Contributing document.
-
-* http://wiki.opscode.com/display/chef/How+to+Contribute
-
-You will also need to set up the repository with the appropriate branches. We document the process on the Chef Wiki.
-
-* http://wiki.opscode.com/display/chef/Working+with+git
-
-Once your repository is set up, you can start working on the code. We do use TDD with RSpec, so you'll need to get a development environment running.
-
-== REQUIREMENTS:
-
-Ruby 1.8.7+ [1]
-
-[1] As of 2012-05-25 Ruby 1.8.6 should still work, except for CHEF-2329.
-
-== ENVIRONMENT:
-
-In order to have a development environment where changes to the Chef code can be tested, we'll need to install a few things after setting up the Git repository.
-
-=== Non-Gem Dependencies
-
-Install these via your platform's preferred method; for example apt, yum, ports, emerge, etc.
-
-* Git[http://git-scm.com/]
-* GCC and C Standard Libraries, header files, etc. (i.e., build-essential on debian/ubuntu)
-* Ruby development package
-
-=== Runtime Rubygem Dependencies
-==== Chef Client and Solo
-* ohai
-* erubis
-* highline
-* json (1.4.4 - 1.4.6)
-* mixlib-authentication
-* mixlib-cli
-* mixlib-config
-* mixlib-log
-* moneta
-* rest-client
-* uuidtools
-* merb-core
-* net-ssh
-* fog
-
-=== Development Rubygem Dependencies
-* rake[http://rake.rubyforge.org/]
-* rspec[http://rspec.info/]
-
-Ohai is also by Opscode and available on GitHub, http://github.com/opscode/ohai/tree/master.
-
-== Spec testing:
-
-We use RSpec for unit/spec tests. It is not necessary to start the development
-environment to run the specs--they are completely standalone.
-
- rake spec
-
-== LINKS:
-
-Source:
-
-* http://github.com/opscode/chef/tree/master
-
-Tickets/Issues:
-
-* http://tickets.opscode.com/
-
-Documentation:
-
-* http://wiki.opscode.com/display/chef/Home/
-
-= LICENSE:
-
-Chef - A configuration management system
-
-Author:: Adam Jacob (<adam@opscode.com>)
-Copyright:: Copyright (c) 2008-2012 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.
View
@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
s.version = Chef::VERSION
s.platform = Gem::Platform::RUBY
s.has_rdoc = true
- s.extra_rdoc_files = ["README.rdoc", "LICENSE" ]
+ s.extra_rdoc_files = ["README.md", "CONTRIBUTING.md", "LICENSE" ]
s.summary = "A systems integration framework, built to bring the benefits of configuration management to your entire infrastructure."
s.description = s.summary
s.author = "Adam Jacob"
@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
s.add_dependency "net-ssh-multi", "~> 1.1.0"
# CHEF-3027: The knife-cloud plugins require newer features from highline, core chef should not.
s.add_dependency "highline", ">= 1.6.9"
- %w{erubis moneta uuidtools}.each { |gem| s.add_dependency gem }
+ %w{erubis moneta}.each { |gem| s.add_dependency gem }
# development_dependency thin: eventmachine 0.12.10 doesn't support Ruby 1.9 on Windows
%w(rdoc sdoc ronn rake rack rspec_junit_formatter).each { |gem| s.add_development_dependency gem }
@@ -36,5 +36,5 @@ Gem::Specification.new do |s|
s.bindir = "bin"
s.executables = %w( chef-client chef-solo knife chef-shell shef )
s.require_path = 'lib'
- s.files = %w(Rakefile LICENSE README.rdoc) + Dir.glob("{distro,lib,tasks,spec}/**/*")
+ s.files = %w(Rakefile LICENSE README.md CONTRIBUTING.md) + Dir.glob("{distro,lib,tasks,spec}/**/*")
end

0 comments on commit 555b2c1

Please sign in to comment.