README.md 1.71 KB
Newer Older
Jan-Tarek Butt's avatar
Jan-Tarek Butt committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
# fpm-cookery - For building software

A tool for building software packages with
[fpm](https://github.com/jordansissel/fpm).

The [fpm](https://github.com/jordansissel/fpm) project is really nice for
building operating system packages like `.deb` and `.rpm`. But it only helps
you to create the packages and doesn't help you with actually building the
software.

__fpm-cookery__ provides an infrastructure to automatically build software
based on recipes. It's heavily inspired and borrows code from the great
[homebrew](https://github.com/mxcl/homebrew) and
[brew2deb](https://github.com/tmm1/brew2deb) projects.
The [OpenBSD Ports System](http://www.openbsd.org/faq/ports/index.html) is
probably another source of inspiration since I've been working with that for
quite some time

It is using __fpm__ to create the actual packages.

## Documentation

Please find the documentation page here: https://fpm-cookery.readthedocs.org/

The documentation source is located in the `docs/` folder. Pull requests welcome! :)

Hosting and building of the documentation is provided by the great [Read the Docs project](https://readthedocs.org/)!

Installation
------------

Jan-Tarek Butt's avatar
Jan-Tarek Butt committed
32 33
## Rubygems

Jan-Tarek Butt's avatar
Jan-Tarek Butt committed
34 35 36 37 38

fpm-cookery is written in Ruby. Before we can actually install the rubygem, you
have to install a Ruby interpreter and some build tools.
Execute the following to install the required packages::

Jan-Tarek Butt's avatar
Jan-Tarek Butt committed
39
  $ sudo apt-get install ruby ruby-dev build-essential curl
Jan-Tarek Butt's avatar
Jan-Tarek Butt committed
40 41 42 43 44 45 46 47 48

Ruby 1.9 includes the ``gem`` program to install rubygems::

  $ sudo gem install fpm-cookery

This installs the fpm-cookery rubygem and its dependencies. At the end you
should see something like "Successfully installed fpm-cookery-|version|".

Your fpm-cookery installation is ready to build some packages now!