README.in

   1 README for Cogl @COGL_1_VERSION@
   2 ===============================================================================
   3
   4 Note: This file is delimited with -- markers so it is possible to split
   5 sections out for other purposes, such as for release notes.
   6
   7 --
   8 DESCRIPTION
   9 -------------------------------------------------------------------------------
  10
  11 Cogl is a small open source library for using 3D graphics hardware for
  12 rendering. The API departs from the flat state machine style of OpenGL and is
  13 designed to make it easy to write orthogonal components that can render without
  14 stepping on each others toes.
  15
  16 As well as aiming for a nice API, we think having a single library as opposed
  17 to an API specification like OpenGL has a few advantages too; like being
  18 able to paper over the inconsistencies/bugs of different OpenGL
  19 implementations in a centralized place, not to mention the myriad of OpenGL
  20 extensions. It also means we are in a better position to provide utility
  21 APIs that help software developers since they only need to be implemented
  22 once and there is no risk of inconsistency between implementations.
  23
  24 Having other backends, besides OpenGL, such as drm, Gallium or D3D are
  25 options we are interested in for the future.
  26
  27 --
  28 REQUIREMENTS
  29 -------------------------------------------------------------------------------
  30
  31 Cogl currently only requires:
  32
  33   • GLib ≥ @GLIB_REQ_VERSION@
  34   • OpenGL ≥ 1.3 (or 1.2 + multitexturing), or OpenGL ES 2.0 (or 1.1)
  35   • GLX, AGL, WGL or an EGL implementation
  36
  37 Cogl also has optional dependencies:
  38
  39   • GDK-Pixbuf ≥ @GDK_PIXBUF_REQ_VERSION@
  40      - for image loading
  41   • Cairo ≥ @CAIRO_REQ_VERSION@
  42      - for debugging texture atlasing (debug builds only)
  43
  44 The optional Cogl Pango library requires:
  45   • Cairo ≥ @CAIRO_REQ_VERSION@
  46   • PangoCairo ≥ @PANGOCAIRO_REQ_VERSION@
  47
  48 On X11, Cogl depends on the following extensions
  49
  50   • XComposite ≥ @XCOMPOSITE_REQ_VERSION@
  51   • XDamage
  52   • XExt
  53   • XFixes ≥ @XFIXES_REQ_VERSION@
  54
  55 When running with OpenGL, Cogl requires at least version 1.3
  56 or 1.2 with the multitexturing extension. However to build Cogl
  57 you will need the latest GL headers which can be obtained from:
  58
  59   http://www.khronos.org
  60
  61 If you are building the API reference you will also need:
  62
  63   • GTK-Doc ≥ @GTK_DOC_REQ_VERSION@
  64
  65 If you are building the additional documentation you will also need:
  66
  67   • xsltproc
  68   • jw (optional, for generating PDFs)
  69
  70 If you are building the Introspection data you will also need:
  71
  72   • GObject-Introspection ≥ @GI_REQ_VERSION@
  73
  74 GObject-Introspection is available from:
  75
  76   git://git.gnome.org/gobject-introspection
  77
  78 If you want support for profiling Cogl you will also need:
  79
  80   • UProf ≥ @UPROF_REQ_VERSION@
  81
  82 UProf is available from:
  83
  84   git://github.com/rib/UProf.git
  85
  86 --
  87 DOCUMENTATION
  88 -------------------------------------------------------------------------------
  89
  90 The API references for the latest stable release are available at:
  91
  92    http://docs.clutter-project.org/docs/cogl/stable/
  93
  94 The experimental 2.0 API can be found here:
  95
  96    http://docs.clutter-project.org/docs/cogl-2.0-experimental/stable/
  97
  98    Note: The confusing "stable" at the end refers to the overall Cogl release
  99    status, not the documentation specifically.
 100
 101 --
 102 LICENSE
 103 -------------------------------------------------------------------------------
 104
 105 Most of Cogl is licensed under the terms of the GNU Lesser General Public
 106 License, version 2.1 or (at your option) later. Some files are licensed under
 107 more permissive licenses MIT or BSD style licenses though so please see
 108 individual files for details.
 109
 110 --
 111 BUILDING AND INSTALLATION
 112 -------------------------------------------------------------------------------
 113
 114 Please refer to the INSTALL document.
 115
 116 --
 117 BUGS
 118 -------------------------------------------------------------------------------
 119
 120 Please report bugs here:
 121
 122   http://bugzilla.gnome.org/enter_bug.cgi?product=cogl
 123
 124 You will need a Bugzilla account.
 125
 126 Please include the following in bug reports:
 127
 128   • what system you're running Cogl on;
 129   • which version of Cogl you are using;
 130   • which version of GLib and OpenGL (or OpenGL ES) you are using;
 131   • which video card and which drivers you are using, including output of
 132     glxinfo and xdpyinfo (if applicable);
 133   • how to reproduce the bug.
 134
 135 If you cannot reproduce the bug with one of the tests that come with
 136 Cogl's source code, it can help a lot to include a small test case
 137 displaying the bad behaviour.
 138
 139 If the bug exposes a crash, the exact text printed out and a stack trace
 140 obtained using gdb are greatly appreciated.
 141
 142 --
 143 CONTRIBUTING
 144 -------------------------------------------------------------------------------
 145
 146 The CODING_STYLE file describes the coding style we use throughout Cogl,
 147 please try your best to conform to this style because the consistency
 148 really helps keep the code maintainable.
 149
 150 We can accept contributions in several ways:
 151   • Either as patches attached to bugs on bugzilla
 152       - For this you may be interested in using git-bz.
 153
 154         See http://git.fishsoup.net/man/git-bz.html for details
 155   • You can email us patches
 156       - For this we recommend using git-send-email
 157
 158   • You can create a remote branch and ask us to pull from that for more
 159     substantial changes.
 160       - For this we recommend using github.
 161
 162 Ideally standalone patches should be created using git format-patch since
 163 that makes it easiest to import the patch with a commit message into a
 164 git repository.