README.rst 1.5 KB
Newer Older
sirex's avatar
initial  
sirex committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
*******************************
Recipe for installing ruby gems
*******************************

Using this recipe you can easily install ruby gems packages into buildout
environment.

All executable files from gem packages are available in ``bin-directory``.

Usage
=====

::

    [buildout]
    parts =
        rubygems

    [rubygems]
    recipe = rubygemsrecipe
    gems =
        sass
23
        compass==0.10
sirex's avatar
initial  
sirex committed
24 25 26 27

After running buildout you can use SASS from buildout environment::

    ./bin/sass --version
28 29 30 31 32

Options
=======

gems
33 34
    list of gem package names, also you can specify gem version, example:
    ``sass==3.1.1``.
35

36 37 38 39
url
    rubygems zip download url, if not specified, recipe will try to find most
    recent version.

40 41
version
    rubygems version, if not specified, recipe will try to find most recent
42
    version. Mutually exclusive with url option.
43 44 45

ruby-executable
    A path to a Ruby executable. Gems will be installed using this executable.
46

47 48
deployment
    If set to ``true``, the version of each gem dependency must be provided in
49
    ``gems`` option. Default value is ``not allow-picked-versions``. 
50

51 52 53 54 55 56 57 58 59 60 61 62 63
gem-options
    Extra options, that will be passed to gem executable. Example::

        gem-options =
            --with-icu-lib=${icu:location}/lib/
            --with-icu-dir=${icu:location}/

environment
    Possibility to add or override environment variables. Example::

        environment =
            LDFLAGS = -L${icu:location}/lib -Wl,-rpath=${icu:location}/lib
            CFLAGS = -I${icu:location}/include