WHAT IT IS
----------

Pigment is a library designed to easily build user interfaces for
embedded multimedia. Its design allows to use it on several platforms,
thanks to a plugin system allowing to choose the underlying graphical
API.

WHERE TO START
--------------

We have a development website at https://code.fluendo.com/pigment/trac

You can generate the Pigment API documentation typing

  ./autogen.sh && make

and then point your browser to docs/pgm/html/index.html.

You can subscribe to our mailing lists; see the website for details.

We track bugs in Trac on the website.

You can join us on IRC at #pigment on irc.freenode.org

PLATFORMS
---------

- Linux is of course fully supported.
- MacOSX is supported by the OpenGL plugin with a dedicated backend.
- Windows is not supported yet; a backend for the OpenGL plugin still
  needs to be completed.

INSTALLING FROM PACKAGES
------------------------

You should always prefer installing from packages first. There are Pigment
packages for a number of distributions, including Fedora, Debian, Ubuntu,
Mandrake, Gentoo, etc.

Only in cases where you:
- want to hack on Pigment
- want to verify that a bug has been fixed
- do not have a sane distribution
should you choose to build from source tarballs or SVN.

COMPILING FROM SVN
------------------

To build Pigment from repository source code, you simply do something
like this:

  svn co https://code.fluendo.com/pigment/svn/trunk pigment
  cd pigment
  ./autogen.sh --prefix=/opt/pigment
  make
  make install

You can also run Pigment uninstalled. The script misc/pgm-uninstalled is
helpful in setting up your environment for this:

  svn co https://code.fluendo.com/pigment/svn/trunk pigment
  cd pigment
  ./autogen.sh
  make
  ./misc/pgm-uninstalled

BUILD DEPENDENCIES
------------------

Ubuntu Edgy & Feisty:

  Core dependencies:
  - autoconf
  - automake1.7
  - libglib2.0-dev
  - libgtk2-dev
  - gtk-doc-tools
  - libgstreamer0.10-dev
  - libgstreamer-plugins-base0.10-dev
  - python2.4-dev
  - python-gobject-dev
  - python2.4-gst0.10

  OpenGL plugin:
  - libx11-dev
  - libgl1-mesa-dev
  - libpango1.0-dev
  - libcairo-dev

Fedora 6 & 7:

  Core dependencies:
  - automake17
  - gtk-doc
  - gstreamer-devel
  - gsreamer-plugins-base-devel
  - gstreamer-python
  - glib2-devel
  - gdk-pixbuf-devel
  - python-devel
  - pygobject2-devel
  - pygtk2-devel

  OpenGL plugin:
  - libX11-devel
  - mesa-libGLU-devel
  - pango-devel
  - cairo-devel
