README 2.37 KB
Newer Older
Jon Nordby's avatar
Jon Nordby committed
1 2
gegl-gtk: Utility library for using GEGL in GTK+ based applications.

Jon Nordby's avatar
Jon Nordby committed
3
License: Library is LGPLv3+, examples GPLv3+
Jon Nordby's avatar
Jon Nordby committed
4 5 6 7
Maintainer: Jon Nordby <jononor@gmail.com>
Homepage: http://www.gegl.org
Code: http://git.gnome.org/browse/gegl-gtk/
Bugtracker: http://bugs.gnome.org, product GEGL, component gegl-gtk
Jon Nordby's avatar
Jon Nordby committed
8
Mailinglist: http://mail.gnome.org/mailman/listinfo/gegl-developer-list
Jon Nordby's avatar
Jon Nordby committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38

== Installing ==
gegl-gtk uses an autotools build system. To install do:
 ./autogen.sh (from git) or ./configure (from tarball)
 make
 make install

To install to a custom prefix, pass --prefix to autogen.sh/configure. Example:
 ./autogen.sh --prefix=/home/user/gegl-gtk

gegl-gtk uses pkg-config to find its dependencies, set PKG_CONFIG_PATH to
configure which dependencies it is built against.

== Using ==
To use gegl-gtk in your project from C, use the provided pkg-config file
 pkg-config gegl-gtk2-0.1 --libs --cflags

gegl-gtk also has GObject Introspection support, and can be used from
languages like Python, Vala and Javascript.

== Documentation ==
See this file, the examples and source code, for now. :)

== Contributing ==
To contribute code, please file a bug and attach git-formatted patches there, or link to
a public git branch which has the commits (on github for instance).
For quick, simple and obvious fixes, you may send a patch to the mailinglist.

For a list of tasks that needs to be done see the TODO section of this document,
and the TODO, FIXME and XXX comments in the source code.
Jon Nordby's avatar
Jon Nordby committed
39 40

== TODO ==
Jon Nordby's avatar
Jon Nordby committed
41 42
Currently the focus is on the 0.1.0 release. The 0.1 series will
have a basic set of features, and maintain ABI and API compatability.
Jon Nordby's avatar
Jon Nordby committed
43

Jon Nordby's avatar
Jon Nordby committed
44 45 46 47 48 49
=== 0.1.0 ===
First release. Goal: minimally useful, solid interfaces.
Should at happen before or together with the next Gegl release.
Need to build and work with whatever is the latest Gegl release.

* API review, check naming
50
* Complete API documentation
Jon Nordby's avatar
Jon Nordby committed
51
* Simple examples for all provided features
Jon Nordby's avatar
Jon Nordby committed
52
* Add support for autocentering
Jon Nordby's avatar
Jon Nordby committed
53 54 55 56 57

* Test bindings. At least using Python and Vala (maybe JavaScript)

(hopefully, can be punted)
* Tests for transformations
Jon Nordby's avatar
Jon Nordby committed
58 59
* Register display operation in a generic way with GEGL (needs work in GEGL)
* Display operation needs to spin its own mainloop
Jon Nordby's avatar
Jon Nordby committed
60

Jon Nordby's avatar
Jon Nordby committed
61 62 63
=== Later ===
General
* Write a Gegl based GdkPixbuf loader plugin
Jon Nordby's avatar
Jon Nordby committed
64

Jon Nordby's avatar
Jon Nordby committed
65 66
GeglView
* Add rotation support
Jon Nordby's avatar
Jon Nordby committed
67
* Performance optimizations
Jon Nordby's avatar
Jon Nordby committed
68 69

== BUGS ==
Jon Nordby's avatar
Jon Nordby committed
70
* gegl-gtk-paint often does not update correctly on paint strokes