echoe

Echoe is a simple tool for working with Rubygems. It generates Rake tasks for documentation, testing, packaging, and deployment.

== 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

First, organize your gem according to the usual structure:

  lib/
  bin/  
  ext/
  README
  LICENSE
  CHANGELOG
  Rakefile

Your <tt>CHANGELOG</tt> should be formatted as follows (including newlines):

  v2.1. newest change
  
  v2. older change
  
  v1.9. oldest change
  
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")
  
More advanced configuration is described in the Echoe class.

== Deploying your gem

Now, to build your documentation and deploy the gem:

  rake build_manifest
  rake publish_docs
  rake release

== All Rake tasks

The following tasks are made available to your gem.

Packaging:

* <tt>build_manifest</tt> -  Build a Manifest list.
* <tt>docs</tt> -  Build the documentation.
* <tt>package</tt> -  Build all the packages.

Testing:

* <tt>test</tt> -  Run the test suite.
* <tt>install</tt> -  Install the gem locally.
* <tt>uninstall</tt> -  Uninstall the gem.

Upload:

* <tt>publish_docs</tt> -  Publish documentation to the web.
* <tt>release</tt> -  Package and upload the latest release to Rubyforge.

Cleaning:

* <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.