From 3a498a481f316c0092ddf4be80611ae5aef35419 Mon Sep 17 00:00:00 2001 From: Tomas Frydrych Date: Fri, 15 Feb 2008 16:17:31 +0000 Subject: [PATCH] 2008-02-15 Tomas Frydrych * clutter-docs.sgml: Build instructions for Linux and Windows. --- doc/reference/ChangeLog | 7 +- doc/reference/clutter-docs.sgml | 129 +++++++++++++++++++++++++++++--- 2 files changed, 123 insertions(+), 13 deletions(-) diff --git a/doc/reference/ChangeLog b/doc/reference/ChangeLog index 74f5cfe41..981acbea3 100644 --- a/doc/reference/ChangeLog +++ b/doc/reference/ChangeLog @@ -1,3 +1,8 @@ +2008-02-15 Tomas Frydrych + + * clutter-docs.sgml: + Build instructions for Linux and Windows. + 2008-02-15 Emmanuele Bassi * clutter-animation.sgml: Fix the animations documentation. @@ -84,7 +89,7 @@ clutter_texture_new_from_actor clutter_entry_set_cursor_position clutter_entry_get_cursor_position - + Remove: clutter_actor_apply_shader diff --git a/doc/reference/clutter-docs.sgml b/doc/reference/clutter-docs.sgml index dd149eb2d..a8216cc0d 100644 --- a/doc/reference/clutter-docs.sgml +++ b/doc/reference/clutter-docs.sgml @@ -1,5 +1,5 @@ - @@ -67,7 +67,7 @@ Actors are also able to receive events. - + Subclasses of #ClutterActor include #ClutterStage, #ClutterTexture, #ClutterLabel, #ClutterRectangle, #ClutterEntry and @@ -76,13 +76,13 @@ - + #ClutterStage is the top level #ClutterActor - it's the representation of a window, or framebuffer. It is created automatically when Clutter is initialised. #ClutterStage is a #ClutterGroup, a class implementing the #ClutterCointainer interface. Clutter currently only supports a single stage. - + @@ -110,9 +110,8 @@ - - - Clutter depends on the following libraries: +
+ Clutter Dependencies @@ -157,11 +156,117 @@ - +
- - FIXME: Linux, Windows, OSX. Embedded? - +
+ Platform-specific instructions + +
+ Linux + + If you are using Debian or Ubuntu, you can install pre-compiled + binary packages the normal Debian way following the instructions at + + http://debian.o-hand.com/. + + + To build Clutter clutter from sources, get the latest source + archives from + http://www.clutter-project.org/sources/. Once you have extracted + the sources from the archive execute the following commands in the + top-level directory: + + + + ./configure + make + make install + + + You can configure the build with number of additional arguments + passed to the configure script, the full list of which can be obtained + by running ./configure --help. The following arguments are specific to + Clutter: + + + + --enable-debug=[no/minimum/yes] + + Turns on debugging. Possible values are: yes - all + glib asserts, checks and runtime clutter verbose messages; + minimum - just glib cast checks and runtime clutter verbose + messagaes; no - no glib asserts or checks and no runtime + clutter verbose messages; default=yes. + + + + + + --enable-maintainer-flags=[no/yes] + + Use strict compiler flags; default=no. + + + + + + --enable-gtk-doc + + Use gtk-doc to build documentation; default=no. + + + + + + --enable-manual=[no/yes] + + Build application developers manual; requires jw and + xmlto binaries; default=no. + + + + + + --with-flavour=[glx/eglx/eglnative/sdl] + + Select the Clutter backend. + + + + + + + +
+ +
+ Windows + + The recommended way of building Clutter for Windows is using the + mingw tool + chain. One option is to cross-compile Clutter under Linux -- you + can use the script found in the build/mingw/ + directory to simplify the process (the script takes care of setting + up the necessary dependencies). + + + + If you wish to build Clutter using mingw direcly under Windows, you + can do so the normal *nix way (described above) using the mingw + POSIX shell. Should you prefer to use Microsoft Visual Studio, a + project file for MSVC 2005 is located in the + build/msvc_2k5/ directory. In either case, you + will need to first install the required dependencies. + +
+ +
+ OSX + + +
+
@@ -267,7 +372,7 @@ All backends have a common API for querying the underlying platform, and some of them might have specific API exposed by Clutter. - +