achadwick-test / libmypaint

libmypaint, a.k.a. "brushlib", is a library for making brushstrokes which is used by MyPaint and other projects.

libmypaint - MyPaint brush engine library

This is a self-contained C library that is isolated from MyPaint. It allows other applications to make use of the MyPaint brush engine.

License: ISC, see COPYING for details

Prerequisites

Build dependencies:

• json-c (>= 0.11)
• SCons
• Python

Optional dependencies:

• GEGL + BABL (for enable_gegl=true)
• GObjectIntrospection (for enable_introspection=true)

Building

To build for a given prefix, but not install any files yet:

$ scons prefix=/tmp/testprefix1
$ scons prefix=/tmp/testprefix1 .

These two lines are equivalent. SCons's default target location is . (the current working directory).

To build and install libmypaint somewhere else, you will need to supply a different target location. For the simplest case, the target is the same as the prefix.

$ scons prefix=/tmp/testprefix1 install
$ scons prefix=/tmp/testprefix1 /tmp/testprefix1

These two lines are equivalent too. To save time, install is an alias for the current value of the prefix build variable.

Packagers often need the ability to build for a given prefix, but have to install somewhere else. We recommend using the sandboxing options built into SCons for this.

$ scons prefix=/usr --install-sandbox=/tmp/sandbox1 /tmp/sandbox1

This builds libmypaint as if its eventual prefix will be /usr, but puts the files into /tmp/sandbox1/usr as if the sandbox was the root of the filesystem. Note that you have to repeat the sandbox location in this case.

You can also build a minimal version of libmypaint directly into your application by including "libmypaint.c".

Build options

To list out libmypaint's build variables, with help texts, run

$ scons --help

Testing

Please run the test suite before sending any pull requests. You must build libmypaint staticly for the tests to run. We use python-nose as a test runner. Run the test suite like this:

$ scons use_sharedlib=false
$ nosetests

Documentation

Further documentation can be found in the MyPaint wiki: https://github.com/mypaint/mypaint/wiki/Brushlib.