From c74ba61110492e2705392931438baa90f67cf26f Mon Sep 17 00:00:00 2001 From: Nicola Fontana Date: Wed, 14 Aug 2013 17:17:21 +0200 Subject: [PATCH] doc: improved README stuff Merged README.xml and README.md, added pango-cairo dependency and (hopefully) improved grammar. --- README.md | 12 +++++++++++- docs/adg/README.xml | 19 +++++++++++++------ 2 files changed, 24 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 76fd0a6c..51de1af2 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,10 @@ bindings for higher level languages (the garbage-collected ones, above all). An application can then be developed using any specific language available, much in the same way as [GNOME](http://www.gnome.org/) applications are conceived. +Lua bindings based on [LGI](http://github.com/pavouk/lgi) are +yet availables and effectively used upstream to test the APIs. +The adg-lua (http://dev.entidi.com/p/adg-lua/) project +provides code examples on how to use them. The mathematical and geometrical algorithms, together with a bunch of other useful functions for manipulating cairo paths, are kept @@ -62,12 +66,18 @@ The ADG library has the following dependencies: * [GTK+](http://www.gtk.org/) 3.0.0 or later (or GTK+ 2.12.0 or later for GTK+2 support) to optionally include GTK+ support and build the adg-demo program; - * [gtk-doc](http://www.gtk.org/gtk-doc/) 1.9 or later (optional), + * [pango-cairo](http://www.pango.org/) 1.18.0 or later (optional) + to support a serious engine for rendering text instead of using + the default cairo "toy" APIs; + * [gtk-doc](http://www.gtk.org/gtk-doc/) 1.12 or later (optional), used to regenerate the API documentation * [GObject introspection](http://live.gnome.org/GObjectIntrospection) 0.9.5 or later (optional) to dinamically generate bindings metadata. +The required packages must be installed prior the ADG building: +they should be availables on nearly every decent unix-like system. + The ADG is mainly developed on GNU/Linux but its dependecies are known to be cross platform so a porting should be quite easy, if not automatic. Anyway, the cross-compilation of a Windows diff --git a/docs/adg/README.xml b/docs/adg/README.xml index ac40abac..7975ff4b 100644 --- a/docs/adg/README.xml +++ b/docs/adg/README.xml @@ -45,9 +45,12 @@ approach. Applications based on ADG are not expected to be developed in C, though: the basic idea is to have a set of language bindings for higher level languages (the garbage-collected ones, above all). An application can then be developed using any -specific language available, much in the same way as GNOME -applications are conceived. Lua bindings are yet availables from -the adg-lua project. +specific language available, much in the same way as +GNOME applications are conceived. +Lua bindings based on LGI are +yet availables and effectively used upstream to test the APIs. +The adg-lua project +provides code examples on how to use them. The mathematical and geometrical algorithms, together with a bunch of other useful functions for manipulating cairo paths, are kept @@ -76,7 +79,10 @@ list can be browsed onlineGTK+ 3.0.0 or later (or GTK+ 2.12.0 or later for GTK+2 support) to optionally include GTK+ support and build the adg-demo program; - gtk-doc 1.9 or later (optional), + pango-cairo 1.18.0 or later (optional) + to support a serious engine for rendering text instead of using + the default cairo "toy" APIs; + gtk-doc 1.12 or later (optional), used to regenerate the API documentation GObject introspection 0.9.5 or later (optional) to dinamically generate bindings @@ -84,8 +90,9 @@ list can be browsed online The required packages must be installed prior the ADG building: -they should be provided by nearly every decent unix-like system. -The ADG is mainly developed on GNU/Linux but its dependecies are +they should be availables on nearly every decent unix-like system. + +The ADG is mainly developed on GNU/Linux but its dependecies are known to be cross platform so a porting should be quite easy, if not automatic. Anyway, the cross-compilation of a Windows installer is supported upstream and it is based on the ArchLinux -- 2.11.4.GIT