Mr Bones version 1.3.3
by Tim Pease
http://codeforpeople.rubyforge.org/bones
(the "Fractal Bovine" release)
== DESCRIPTION
Mr Bones is a handy tool that builds a skeleton for your new Ruby projects.
The skeleton contains some starter code and a collection of rake tasks to
ease the management and deployment of your source code. Mr Bones is not
viral -- all the code your project needs is included in the skeleton (no
gem dependency required).
== CHANGES
* 4 minor enhancements
- The annotation tags to search for can be specified by the user
in the Rakefile
- Directory names can be substituted during skeleton creation
- Support for the GEM post_install_message
- Support to generate an announcement text file and send the
announcement via e-mail
- Added a manifest:assert task that can be used when building the
gem to assert that the manifest is up to date
task 'gem:package' => 'manifest:assert'
* 1 bug fix
- Fixed a circular dependency in the gem creation tasks
== INSTALL
* sudo gem install bones
== SYNOPSIS
To create a new "Get Fuzzy" project:
bones get_fuzzy
If a new release of Mr Bones comes out with better features the "Get Fuzzy"
project will need to be updated:
bones --update get_fuzzy
And if you ever get confused about what Mr Bones can do:
bones --help
== FEATURES
Mr Bones provides the following rake tasks:
ann # Alias to ann:announcement
ann:announcement # Create an announcement file
ann:email # Send email announcement
clobber # Remove all build products
doc # Alias to doc:rdoc
doc:rdoc # Build the rdoc HTML Files
doc:release # Publish RDoc to RubyForge
doc:rerdoc # Force a rebuild of the RDOC files
doc:ri # Generate ri locally for testing
gem # Alias to gem:package
gem:debug # Show information about the gem
gem:gem # Build the gem file bones-1.3.3.gem
gem:install # Install the gem
gem:package # Build all the packages
gem:release # Package and upload to RubyForge
gem:repackage # Force a rebuild of the package files
gem:uninstall # Uninstall the gem
manifest # Alias to manifest:check
manifest:check # Verify the manifest
manifest:create # Create a new manifest
notes # Enumerate all annotations
notes:fixme # Enumerate all FIXME annotations
notes:optimize # Enumerate all OPTIMIZE annotations
notes:todo # Enumerate all TODO annotations
spec # Alias to spec:run
spec:rcov # Run all specs with RCov
spec:run # Run all specs with basic output
spec:specdoc # Run all specs with text output
svn:create_tag # Create a new tag in the SVN repository
svn:show_tags # Show tags from the SVN repository
test # Alias to test:run
test:rcov # Run rcov on the unit tests
test:run # Run tests for run
The rake tasks in the Mr Bones framework can be found in the "tasks"
directory. Add your own tasks there when you need more functionality.
== REQUIREMENTS
Mr Bones does not have any "requirements", but if you do not have the
following gems installed you will not get all that Mr Bones has to offer.
* rubyforge - for easy gem publishing to rubyforge.org
* rcov - for code coverage testing
* rspec - if that's the way you roll
== FUN FACT
Half of all Americans are below average.
== POST SCRIPT
Blessings,
TwP
···
--------------------------
Keep rattlin' dem bones!
--------------------------
Thank you, Tim!