README.in

   1 Clutter README.
   2 ===============
   3
   4 This is Clutter @CLUTTER_VERSION@. Clutter aims to give a nice easy
   5 GObject based API for creating fast, mainly 2D single window stylalised
   6 applications such as media box UI's, presentaions, kiosk style apps etc.
   7 It uses OpenGL for rendering.
   8
   9 Its not meant to be a full featured GUI toolkit for regular desktop
  10 apps nor provide a general interface to *all* OpenGL functionality.
  11
  12 It currently uses fairly low end GL functionality with an aim to still
  13 work well on open source graphics drivers as well as possibly making
  14 an eventual GL ES port feasable.
  15
  16 Clutter currently requires GLib >= 2.10, GdkPixbuf and OpenGL >= 1.2.
  17 Its also recommended you have some kind of working hardware OpenGL on
  18 your target system.
  19
  20 Clutter is LGPL licensed.
  21
  22 The official website is:        http://www.clutter-project.org
  23
  24 INSTALLATION
  25 ====
  26 See the INSTALL file
  27
  28 RELEASE NOTES
  29 ====
  30
  31 Release Notes for Clutter 0.4
  32 -----------------------------
  33
  34 * ...
  35
  36 HACKING
  37 ====
  38 If you want to hack on and improve clutter check the TODO file.
  39
  40 BUGS
  41 ====
  42
  43 Bugs should be reported to the OpenedHand Bugzilla at:
  44
  45   http://bugzilla.o-hand.com
  46
  47 Under the product "Clutter".
  48
  49 In the report you should include:
  50 * what system you're running Clutter on;
  51 * which version of GLib, GdkPixbuf and OpenGL you are using;
  52 * which video card and which drivers you are using;
  53 * how to reproduce the bug.
  54
  55 If you cannot reproduce the bug with one of the tests that come with Clutter
  56 source code, you should include a small test case displaying the bad
  57 behaviour.
  58
  59 If the bug exposes a crash, the exact text printed out and a stack trace
  60 obtained using gdb are greatly appreciated.
  61
  62 PATCHES
  63 ====
  64
  65 Patches should be submitted using Bugzilla. Patches fixing a bug should be
  66 attached to the bug report; patches for new features or for fixing bugs not
  67 yet reported should be attached to a newly opened bug. Patches should always
  68 be in the unified diff format.