T
Tim Pease
Bones
by Tim Pease
<http://codeforpeople.rubyforge.org/bones>
== 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).
== FEATURES/PROBLEMS:
Mr Bones provides the following rake tasks:
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 gemackage
gem:debug # Show information about the gem
gem:gem # Build the gem file
gem:install # Install the gem
gemackage # 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:check # Verify the manifest
manifest:create # Create a new manifest
notes # Enumerate all annotations
notes:fixme # Enumerate all FIXME annotations
notesptimize # Enumerate all OPTIMIZE annotations
notes:todo # Enumerate all TODO annotations
spec:rcov # Run all specs with RCov
spec:run # Run all specs with basic output
spec:specdoc # Run all specs with text output
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.
== 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
== 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
== INSTALL:
* sudo gem install bones
See the Mr Bones webpage for more information and a little manual.
<http://codeforpeople.rubyforge.org/bones>
Blessings,
TwP
by Tim Pease
<http://codeforpeople.rubyforge.org/bones>
== 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).
== FEATURES/PROBLEMS:
Mr Bones provides the following rake tasks:
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 gemackage
gem:debug # Show information about the gem
gem:gem # Build the gem file
gem:install # Install the gem
gemackage # 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:check # Verify the manifest
manifest:create # Create a new manifest
notes # Enumerate all annotations
notes:fixme # Enumerate all FIXME annotations
notesptimize # Enumerate all OPTIMIZE annotations
notes:todo # Enumerate all TODO annotations
spec:rcov # Run all specs with RCov
spec:run # Run all specs with basic output
spec:specdoc # Run all specs with text output
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.
== 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
== 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
== INSTALL:
* sudo gem install bones
See the Mr Bones webpage for more information and a little manual.
<http://codeforpeople.rubyforge.org/bones>
Blessings,
TwP