README in echoe-2 vs README in echoe-2.1

- old
+ new

@@ -5,14 +5,27 @@ == License Copyright 2007 Cloudburst, LLC. See included LICENSE file. Portions copyright 2006 Ryan Davis, Zen Spider Software, and used with permission. See included MIT-LICENSE file. -== Usage +== Features -First, organize your gem according to the usual structure: +* simple configuration +* comprehensive gem deployment +* automatic changeset parsing +* documentation upload to any host += Usage + +== Installation + + sudo gem install echoe + +== Project configuration + +Organize your gem according to the usual structure: + lib/ bin/ ext/ README LICENSE @@ -29,31 +42,37 @@ This way Echoe can parse the latest version and changeset message automatically. Your <tt>Rakefile</tt> needs the following minimal contents: - require "rubygems" - require "echoe" - Echoe.new("gem_name") + require 'rubygems' + require 'echoe' + Echoe.new('gem_name') More advanced configuration is described in the Echoe class. == Deploying your gem -Now, to build your documentation and deploy the gem: +First, run <tt>rubyforge setup</tt> and <tt>rubyforge config</tt> if you haven't already. Make sure your Rubyforge password is correctly set. - rake build_manifest - rake publish_docs +Now, to deploy the gem and documentation: + + rake manifest rake release + rake publish_docs +Once you've built your manifest, you only need to rebuild it if you add or remove files from the package structure. + += Extras + == All Rake tasks The following tasks are made available to your gem. Packaging: -* <tt>build_manifest</tt> - Build a Manifest list. +* <tt>manifest</tt> - Build a manifest list. * <tt>docs</tt> - Build the documentation. * <tt>package</tt> - Build all the packages. Testing: @@ -70,5 +89,9 @@ * <tt>clean</tt> - Delete all the generated documentation and packages. * <tt>redocs</tt> - Force a rebuild of the Rdoc files. * <tt>repackage</tt> - Force a rebuild of the package files. +== Further resources + +* http://blog.evanweaver.com/pages/code#echoe +* http://rubyforge.org/forum/forum.php?forum_id=13986