README.rdoc in gemsmith-1.0.0 vs README.rdoc in gemsmith-1.1.0
- old
+ new
@@ -5,15 +5,16 @@
gem. Gemsmith is essentially an enhanced version of Bundler's gem building capabilities.
= Features
* Builds a gem skeleton with Bundler functionality in mind.
-* Allows for common settings that you can apply to new gem creations.
+* Allows for common settings that can be applied to new gem creations.
* Supports binary skeletons with Thor[https://github.com/wycats/thor] command line functionality.
* Supports {Ruby on Rails}[http://rubyonrails.org] skeletons.
* Supports RSpec[http://rspec.info] test skeletons.
* 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.
@@ -57,10 +58,11 @@
From the command line, type: gemsmith help
gemsmith -c, [create=GEM_NAME] # Create new gem.
gemsmith -e, [edit] # Edit gem settings in default editor (assumes $EDITOR environment variable).
gemsmith -h, [help] # Show this message.
+ gemsmith -o, [open=NAME] # Opens gem in default editor (assumes $EDITOR environment variable).
gemsmith -v, [version] # Show version.
For more gem creation options, type: gemsmith help create
-b, [--bin] # Add binary support.
@@ -73,20 +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
+
+To test, change directory to the gem root and run:
+
+ bundle exec rspec spec
+
= Best Practices
-1. 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. {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/].
-= Company
+= Contributions
-{Red Alchemist}[http://www.redalchemist.com]
+Please log all feedback/issues via {GitHub Issues}[https://github.com/bkuhlmann/gemsmith/issues] for the project. Thanks.
-= Author
+= Credits
-{Brooke Kuhlmann}[http://www.redalchemist.com]
+Developed by {Brooke Kuhlmann}[http://www.redalchemist.com] at {Red Alchemist}[http://www.redalchemist.com]
= License
Copyright (c) 2011 {Red Alchemist}[http://www.redalchemist.com].
Read the LICENSE for details.