= trowel

* http://github.com/gcnovus/trowel

== DESCRIPTION:
Trowel helps you write GitHub-based gems.  It's a bit like Hoe, but
probably not as well-written.  In fact, it borrows quite heavily from
Hoe; thanks Seattle Ruby!

== FEATURES/PROBLEMS:

Generated tasks:
* clean          - cleans generated files
* deploy:local      - deploys the gem locally
* gemspec:generate    - generates a gemspec file for GitHub
* gemspec:clean      - deleted the gemspec file
* manifest:verify    - verifies the gem manifest file
* package:assemble    - generates the .gem file in pkg/
* package:clean      - cleans out the .gem file from pkg/

See class rdoc for help. Hint: ri Hoe

== FEATURES/PROBLEMS:

* Provides 'sow' for quick project directory creation.
* Make making and maintaining Rakefiles fun and easy.

== SYNOPSIS:

To create a new gem project on GitHub:

  1.  login to GitHub and create a new project
  2.  % trowel [group] project
  3.  % cd project
  4.  % git init
  5.  % git commit -m 'first commit'
  6.  % git remote add origin git@github.com:username/project.git
  7.  % git push origin master
  8.  http://github.com/username/project/edit and select "RubyGem"
  9.  code, code, code, test, test, test, commit
  10. rake gemspec:generate
  11. git add project.gemspec
  12. git commit -m 'added gemspec for GitHub gem generation'
  13. git push origin master


If you already have a project going, you can just
add Trowel to your existing Rakefile or .task file:

  require 'trowel'
  
  Trowel::define_tasks(projectname, version) do |p|
    # ... project specific data ...
  end

  # ... project specific tasks ...

== REQUIREMENTS:

* rake (gem)
* rubygems (gem)
* an account on GitHub

== INSTALL:

* sudo gem install trowel

== LICENSE:

Copyright (c) 2008 James Rosen

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.