Go to file
Neil Roberts f23a7583e1 mingw-fetch-dependencies.sh: Add a wrapper for pkg-config
On a Fedora system (and maybe others) there is a wrapper script called
i686-pc-mingw32-pkg-config. This script unsets the PKG_CONFIG_PATH
variable and then sets the PKG_CONFIG_LIBDIR variable so that it won't
pick up the native system .pc files. This breaks cross compiling in
mingw-fetch-dependencies.sh because it ends up removing its attempts
to set a local search path.

To fix this, the mingw-fetch-dependencies script now generates its own
wrapper script which instead sets PKG_CONFIG_LIBDIR to the local
clutter-cross prefix and then runs the original pkg-config program
from the search path. This should have the same benefit of preventing
it from finding native system .pc files on systems that don't provide
a cross pkg-config. The cross compiling for json-glib and the
recommend args to pass to configure when building clutter are updated
to set the PKG_CONFIG varible to point to this wrapper script.
2011-03-16 13:06:52 +00:00
build mingw-fetch-dependencies.sh: Add a wrapper for pkg-config 2011-03-16 13:06:52 +00:00
clutter win32: mkdir -p win32 needed for out of tree builds 2011-03-16 11:22:20 +00:00
doc offscreen-effect: Add public accessor for target size 2011-02-28 14:34:36 +00:00
po Post-release version bump to 1.6.7 2011-02-21 14:19:47 +00:00
tests event: Add setters for ClutterEvent members 2011-02-28 14:16:23 +00:00
.gitignore build: Generate README 2011-02-14 17:27:25 +00:00
AUTHORS AUTHORS: Note that the file is unmaintained 2011-03-14 14:16:16 +00:00
autogen.sh autogen.sh: make autoreconf use automake-1.11 when available 2010-12-30 12:08:28 +00:00
ChangeLog.pre-git-import Add a notice of deprecation in the pre-Git ChangeLog 2010-01-14 15:24:15 +00:00
clutter.doap clutter.doap: Add my gnome userid 2011-03-14 14:17:14 +00:00
configure.ac build: Show CFLAGS in the configure summary 2011-02-28 14:16:24 +00:00
COPYING
Makefile.am build: Remove maintainer-clean rule 2011-02-22 18:32:01 +00:00
NEWS Release Clutter 1.6.6 (stable) 2011-02-21 12:47:09 +00:00
README.in docs: Mention the cookbook in the README 2011-02-21 16:41:28 +00:00
README.md README.md: fix a dumb typo 2011-03-14 14:00:12 +00:00

Clutter

What is Clutter?

Clutter is an open source software library for creating fast, compelling, portable, and dynamic graphical user interfaces.

Requirements

Clutter currently requires:

Clutter also has optional dependencies:

On X11, Clutter depends on the following extensions:

  • XComposite
  • XDamage
  • XExt
  • XFixes
  • XInput (1.x or 2.x)
  • XKB

If you are building the API reference you will also need:

If you are building the additional documentation you will also need:

  • xsltproc
  • jw (optional, for generating PDFs)

If you are building the Introspection data you will also need:

If you want support for profiling Clutter you will also need:

Resources

The official Clutter website is:

    http://www.clutter-project.org/

The API references for the latest stable release are available at:

    http://docs.clutter-project.org/docs/clutter/stable/
    http://docs.clutter-project.org/docs/cogl/stable/
    http://docs.clutter-project.org/docs/cally/stable/

The Clutter Cookbook is available at:

    http://docs.clutter-project.org/docs/clutter-cookbook/

New releases of Clutter are available at:

    http://source.clutter-project.org/sources/clutter/

The Clutter blog is available at:

    http://www.clutter-project.org/blog/

To subscribe to the Clutter mailing lists and read the archives, use the Mailman web interface available at:

    http://lists.clutter-project.org/

New bug page on Bugzilla:

    http://bugzilla.clutter-project.org/enter_bug.cgi?product=clutter
    http://bugzilla.clutter-project.org/enter_bug.cgi?product=cogl

Clutter is licensed under the terms of the GNU Lesser General Public License, version 2.1 or (at your option) later: see the COPYING file for more information.

Building and Installation

To build Clutter from a release tarball, the usual autotool triad should be followed:

  1. ./configure
  2. make
  3. make install

To build Clutter from a Git clone, run the autogen.sh script instead of the configure one. The autogen.sh script will run the configure script for you, unless the NOCONFIGURE environment variable is set to a non-empty value.

See also the BuildingClutter page on the wiki.

Versioning

Clutter uses the common "Linux kernel" versioning system, where even-numbered minor versions are stable and odd-numbered minor versions are development snapshots.

Different major versions break both API and ABI but are parallel installable. The same major version with differing minor version is expected to be ABI compatible with other minor versions; differing micro versions are meant just for bug fixing. On odd minor versions the newly added API might still change.

The micro version indicates the origin of the release: even micro numbers are only used for released archives; odd micro numbers are only used on the Git repository.

Contributing

If you want to hack on and improve Clutter check the HACKING file for general implementation guidelines, and the HACKING.backends for backend-specific implementation issues.

The CODING_STYLE file contains the rules for writing code conformant to the style guidelines used throughout Clutter. Remember: the coding style is mandatory; patches not conforming to it will be rejected by default.

The usual workflow for contributions should be:

  1. Fork the repository
  2. Create a branch (git checkout -b my_work)
  3. Commit your changes (git commit -am "Added my awesome feature")
  4. Push to the branch (git push origin my_work)
  5. Create an Issue with a link to your branch
  6. Sit back, relax and wait for feedback and eventual merge

Bugs

Bugs should be reported to the Clutter Bugzilla at:

    http://bugzilla.clutter-project.org/enter_bug.cgi?product=clutter
    http://bugzilla.clutter-project.org/enter_bug.cgi?product=cogl

You will need a Bugzilla account.

In the report you should include:

  • what system you're running Clutter on;
  • which version of Clutter you are using;
  • which version of GLib and OpenGL (or OpenGL ES) you are using;
  • which video card and which drivers you are using, including output of glxinfo and xdpyinfo (if applicable);
  • how to reproduce the bug.

If you cannot reproduce the bug with one of the tests that come with Clutter source code, you should include a small test case displaying the bad behaviour.

If the bug exposes a crash, the exact text printed out and a stack trace obtained using gdb are greatly appreciated.