Box

DESCRIPTION

Box is packaging made simple. It uses Ruby POM Metadata and a MANIFEST file to determine how to build packages. Currently it can build zip, tar.gz and gem packages.

FEATURES

LIMITATIONS

SYNOPSIS

To create any package, change into the project’s root directory, ensure there is a MANIFEST that lists all the files you wish to include in the package. Adn ensure POM entries for meta/project, meta/version and any other metadata you need (gem creation in particular uses a number of these such as summary and requires). Then building packages is as simple as:

To create a zip package:

$ box -t zip

To create a gzipped tarball package:

$ box -t gz

To create a RubyGems package:

$ box -t gem

Since typically we’d rather not clutter up out project’s root directory with package files, if the project has a standard package directory (pkg, pack/ or package/), then the packages with be automatically placed there instead of the current directory.

See Ruby POM (proutils.github.com/pom) to learn more about metadata files.

REQUIREMENTS

Box has three dependencies:

The RubyGem package will install these automatically. If you install via the tarball package, be sure the above requirements are installed as well.

DEVELOPEMNET

Box is a ProUtils project. Development is hosted on GitHub.

http://github.com/proutils/box

COPYRIGHTS

(GNU General Public License)

Copyright © 2006,2009 Thomas Sawyer

Box is distributed under the terms of the GPL version 3.

[Validate]

Generated with the Darkfish Rdoc Generator 2.