bones version 3.0.1
by Tim Pease
http://gemcutter.org/gems/bones
== DESCRIPTION
Mr Bones is a handy tool that creates new Ruby projects from a code
skeleton. The skeleton contains some starter code and a collection of rake
tasks to ease the management and deployment of your source code. Several Mr
Bones plugins are available for creating git repositories, creating GitHub
projects, running various test suites and source code analysis tools.
== CHANGES
* 2 bug fixes
- Fixing the ".git" exclude pattern
- Calling "git clone" when creating from a git repository
(as opposed to git-clone which is not available on all platforms)
If upgrading from a Mr Bones version 2 installation, you will need to modify
your Rakefile to use the new "Bones {}" configuration block. The easiest way
to do this is to create a sample project with the "bones" version 3 command
line tool, and take a look at the new Rakefile style.
The biggest difference is that the PROJ structure has gone away and has been
replaced by a declarative configuration block.
== INSTALL
* gem install bones
If you would like some extra functinoality the following plugins can be
installed:
* gem install bones-git
* gem install bones-extras
The 'bones-git' gem provides command line options for generating a git
repository and pushing to GitHub upon creation. Rake tasks for working with
the git repository are also provided.
The 'bones-extras' gem provides rake tasks for running Rspec tests, running
Rcov on your source code, and pushing releases to RubyForge. You will need to
have the corresponding gems installed for these tasks to be loaded.
== SYNOPSIS
To create a new "Get Fuzzy" project:
bones create get_fuzzy
If you ever get confused about what Mr Bones can do:
bones --help
After your project is created, you can view all the available configuration
options:
rake bones:options
Detailed information about the options (or a subset of options) can also be
displayed:
rake bones:help #=> for all options
rake bones:help gem #=> for the "gem" subset
== FEATURES
Mr Bones is configurable, helpful, and it simplifies project development.
Mr Bones simplifies project creation by using a code template for generating
a new working area for your code. This skeleton is customizable, and you can
have multiple skeletons for various types of projects you work on - ruby
libraries, web applications, or even writing projects.
When working with Rake, Mr Bones provides a set of tasks that help simplify
common development tasks. These tasks include ...
* release announcements
* gem packaging and management
* releasing to gemcutter and rubyforge
* documentation
* annotation listing (TODO, FIXME, etc)
* testing
The provided rake tasks are configured using a "Bones" configuration block in
the Rakefile. You can obtain a list of the available options and descriptive
help for each option by running the various "bones" tasks (use "rake -T" to
list the available tasks). Although there are many configuration options, the
vast majority of them have sensible defaults; tailor to suit your needs in the
Bones configuration block.
Mr Bones can be extended via plugins. The plugins provide new rake tasks and
configuration options for those tasks. Other developers can release plugins to
automate the use of their libraries in a bones enabled system.
Currently there are a "bones-git" plugin for interacting with GitHub and git
repositories and a "bones-extras" plugin for working with Rcov, RubyForge,
and Rspec.
There is far more information available in the Mr Bones manual.
···
--------------------------
Keep rattlin' dem bones!
--------------------------