[gegl-qt] Update README



commit d12a5bce805e0aa3bf4f13dbc2bd8316ad409477
Author: Jon Nordby <jononor gmail com>
Date:   Sun Aug 21 11:52:59 2011 +0200

    Update README
    
    Plans for 0.1.0 release, et.c.

 README.txt |   91 +++++++++++++++++++++++++++++++++++++++++++++++++++--------
 1 files changed, 78 insertions(+), 13 deletions(-)
---
diff --git a/README.txt b/README.txt
index 2afab96..68f4730 100644
--- a/README.txt
+++ b/README.txt
@@ -1,7 +1,11 @@
 gegl-qt: Qt utility library for GEGL.
 
 License: LGPLv3+
-Author: Jon Nordby <jononor gmail com>
+Maintainer: Jon Nordby <jononor gmail com>
+Homepage: http://www.gegl.org
+Code: http://git.gnome.org/browse/gegl-qt/
+Bugtracker: http://bugs.gnome.org, product GEGL (use gegl-qt in title)
+Mailinglist: http://blog.gmane.org/gmane.comp.video.gegl.devel
 
 == Installing ==
 gegl-qt uses the qmake build system. To install do:
@@ -12,29 +16,90 @@ gegl-qt uses the qmake build system. To install do:
 To install to a custom prefix, pass GEGLQT_INSTALL_PREFIX to qmake. Example:
  qmake -r GEGLQT_INSTALL_PREFIX=/home/user/gegl-qt
 
+gegl-qt uses pkg-config to find its dependencies, set PKG_CONFIG_PATH to
+configure which dependencies it is built against.
+
 == Using ==
 To use gegl-qt in your project, use the provided pkg-config file.
  pkg-config gegl-qt4-0.1 --libs --cflags
 
 == Documentation ==
-See the examples and source code, for now. :)
+See this file, the examples and source code, for now. :)
+
+== Features ==
+=== View widgets ===
+- Shows the output of a Gegl graph.
+- QML, QGraphicsView and QWidget versions are provided.
+- Scaling and translation is supported.
+- Can do automatic scaling and centering
+
+=== Gegl display operation ===
+Allows applications to show a
+
+== Purpose & Scope ==
+The purpose of gegl-qt is to make it easy for application developers to
+use GEGL in applications with Qt based user interfaces.
 
-== Scope ==
-gegl-qt aims to support Qt4 and both QWidget, QGraphicsView and QML.
+gegl-qt aims to support Qt4 and both QWidget, QGraphicsView and QML based user interfaces.
 Qt5 support will be considered in the future.
 
-The QML support provided by gegl-qt is meant to enable application writers
-to show Gegl graphs in their QML-based user interface. Providing QML bindings 
-for GEGL so that the graphs can be manipulated programatically using QML is 
-considered to be out-of-scope.
+It is currently outside the scope of gegl-qt to provide C++ (Qt/QObject) or QML bindings
+for GEGL. If you are interested in this, the best way would be to use GObject
+Introspection + Smoke GObject.
+
+== 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.
 
 == TODO ==
+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.
+
+=== 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.
+
+- Fix out-of-tree build
+- Use a namespace, GeglQt, instead of symbol prefix
+- Find good and consistent names for the different view widgets
+- Do API review
+- Create 'make dist' and 'make distcheck' targets
+- Have a basic set of tests, and good test infrastructure
+- Distribute a basic examples for the provided features
+- Add information about gegl-qt to gegl.org website
+
+- Display operation needs to spin its own mainloop
+- Register the display operation as a 'display' type operation (needs support in Gegl)
+
+=== Later ===
 General
-- Python support using PySide and Shiboken
+- Python support using PySide and Shiboken (see 'pyside' branch)
+- API documentation
 
 View widgets
-- Translation
-- Scaling
-- Rotation
+- Rotation support
+- Background and overlay draw support for GeglQtView
+
+QImage IO loader plugin that uses
+
+Tests
+- Unittests for view widgets
+- Regression tests for view widgets rendering
+- Performance benchmarks for view widgets
+
+Examples
+- Interactive examples of Gegl + GeglQt features
+
+=== Maybe ===
+Additional widgets?
+
+- Graph view: Show the entire Gegl graph and allow to manipulate it
+Add/remove and reorder operations.
+- Node properties view: show the properties of a given Gegl node in a graph,
+and allow to manipulate them.
 
-QImage IO loader plugin



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]