gobject-introspection r520 - trunk

[johan svn gnome org]

Author: johan
Date: Fri Aug 29 10:07:53 2008
New Revision: 520
URL: http://svn.gnome.org/viewvc/gobject-introspection?rev=520&view=rev

Log:
Update

Modified:
   trunk/README

Modified: trunk/README
==============================================================================
--- trunk/README	(original)
+++ trunk/README	Fri Aug 29 10:07:53 2008
@@ -1,8 +1,29 @@
 GObject Introspection
-
-GIR & Typelib formats
 =====================
-FIXME
+The goal of the project is to describe the APIs and  collect them in
+a uniform, machine readable format.
+
+GIR XML format
+==============
+
+There's an XML format called GIR used by GObjectIntrospection.
+The purpose of it is to provide a common structure to access the complete
+available API that a library or other unit of code exports.
+It is meant to be language agnostic using namespaces to separate 
+core, language or library specific functionality.
+There are currently only C based tools that work on the format, but it's
+meant to be usable to use in other situations, for instance to/from another
+set of languages.
+
+Typelib
+=======
+
+The typelib is a to disk version of the GIR designed to be fast, memory
+efficient and complete enough so that language bindings can be written
+on top of it without other sources of information.
+It is normally compiled from a GIR when a library/program is installed and
+accessed from the language binding or another application who wishes to
+use the information.
 
 Tools
 =====
@@ -19,6 +40,7 @@
 
 API library
 ===========
+
 There's also a C based library called libgirepository which provides
 an API to access to the typelib metadata. It also contains an API to 
 invoke functions, given the function info object. The implementation is 
@@ -31,3 +53,17 @@
 Helping out
 =========== 
 The introspection framework needs a lot more work, see TODO. 
+
+Homepage
+========
+http://live.gnome.org/GObjectIntrospection
+
+Reporting bugs
+==============
+Bugs should be reported in http://bugzilla.gnome.org/, the glib product and
+the introspection component.
+
+Contact
+=======
+Mail: gtk-devel-list gnome org
+IRC: #introspection irc gnome org