doc: improved README stuff
authorNicola Fontana <ntd@entidi.it>
Wed, 14 Aug 2013 15:17:21 +0000 (14 17:17 +0200)
committerNicola Fontana <ntd@entidi.it>
Wed, 14 Aug 2013 15:33:05 +0000 (14 17:33 +0200)
Merged README.xml and README.md, added pango-cairo dependency and
(hopefully) improved grammar.

README.md
docs/adg/README.xml

index 76fd0a6..51de1af 100644 (file)
--- 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
index ac40aba..7975ff4 100644 (file)
@@ -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 <ulink url="http://adg.entidi.com/lua/">adg-lua</ulink> project.</para>
+specific language available, much in the same way as
+<ulink url="http://www.gnome.org/">GNOME</ulink> applications are conceived.
+Lua bindings based on <ulink url="http://github.com/pavouk/lgi">LGI</ulink> are
+yet availables and effectively used upstream to test the APIs.
+The <ulink url="http://dev.entidi.com/p/adg-lua/">adg-lua</ulink> project
+provides code examples on how to use them.</para>
 
 <para>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 <ulink url="http://cairographics.org/backends/">browsed online</ulin
    <listitem><ulink url="http://www.gtk.org/">GTK+</ulink> 3.0.0 or later (or GTK+ 2.12.0 or
    later for GTK+2 support) to optionally include GTK+ support and
    build the <command>adg-demo</command> program;</listitem>
-   <listitem><ulink url="http://www.gtk.org/gtk-doc/">gtk-doc</ulink> 1.9 or later (optional),
+   <listitem><ulink url="http://www.pango.org/">pango-cairo</ulink> 1.18.0 or later (optional)
+   to support a serious engine for rendering text instead of using
+   the default cairo "toy" APIs;</listitem>
+   <listitem><ulink url="http://www.gtk.org/gtk-doc/">gtk-doc</ulink> 1.12 or later (optional),
    used to regenerate the API documentation</listitem>
    <listitem><ulink url="http://live.gnome.org/GObjectIntrospection">GObject introspection</ulink>
    0.9.5 or later (optional) to dinamically generate bindings
@@ -84,8 +90,9 @@ list can be <ulink url="http://cairographics.org/backends/">browsed online</ulin
 </itemizedlist>
 
 <para>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.</para>
+
+<para>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