README.rdoc in gemsmith-1.1.0 vs README.rdoc in gemsmith-1.2.0
- old
+ new
@@ -14,13 +14,13 @@
* Adds commonly needed README, CHANGELOG, LICENSE, etc. template files.
* Provides the ability to open any installed gem within your favorite editor.
= Requirements
-1. Basic understanding of gem building.
-2. A UNIX-based system.
-3. {Ruby 1.9.x}[http://www.ruby-lang.org]
+1. A UNIX-based system.
+2. {Ruby 1.9.x}[http://www.ruby-lang.org]
+3. RubyGems[http://rubygems.org]
4. Bundler[https://github.com/carlhuda/bundler]
= Setup
Type the following from the command line to install:
@@ -75,23 +75,27 @@
rake build # Build <gem>-<version>.gem into the pkg directory
rake install # Build and install <gem>-<version>.gem into system gems
rake release # Create tag v0.1.1 and build and push <gem>-<version>.gem to Rubygems
-= Tests
+= Best Practices
-To test, change directory to the gem root and run:
+1. {Best Practices While Cutting Gems}[http://rubysource.com/crafting-rubies-best-practices-while-cutting-gems].
+2. {Ruby on Rails Gem Packaging}[http://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices].
+3. {Why You Should Use a BSD Style License}[http://www.freebsd.org/doc/en/articles/bsdl-gpl/article.html].
+4. Ensure the RUBYOPT env variable includes the -w option. {Details}[http://avdi.org/devblog/2011/06/23/how-ruby-helps-you-fix-your-broken-code].
- bundle exec rspec spec
+= Tests
-= Best Practices
+To test, do the following:
-1. {Ruby on Rails Gem Packaging}[http://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices]
-2. Ensure the RUBYOPT env variable includes the -w option. {Details}[http://avdi.org/devblog/2011/06/23/how-ruby-helps-you-fix-your-broken-code/].
+1. cd to the gem root.
+2. bundle install
+3. bundle exec rspec spec
= Contributions
-Please log all feedback/issues via {GitHub Issues}[https://github.com/bkuhlmann/gemsmith/issues] for the project. Thanks.
+Please log all feedback/issues via {GitHub Issues}[https://github.com/bkuhlmann/gemsmith/issues]. Thanks.
= Credits
Developed by {Brooke Kuhlmann}[http://www.redalchemist.com] at {Red Alchemist}[http://www.redalchemist.com]