summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJohan Dahlin <johan@src.gnome.org>2008-08-29 10:07:53 +0000
committerJohan Dahlin <johan@src.gnome.org>2008-08-29 10:07:53 +0000
commit65cd82230a7fe2f3b3cb71b66fc81d74d1e918f1 (patch)
tree66405b0a8f177a7d94e575087ee217e20b6aae52 /README
parent79abab2e4732284b2453b51a745046804e1c1f08 (diff)
downloadgobject-introspection-65cd82230a7fe2f3b3cb71b66fc81d74d1e918f1.tar.gz
Update
svn path=/trunk/; revision=520
Diffstat (limited to 'README')
-rw-r--r--README42
1 files changed, 39 insertions, 3 deletions
diff --git a/README b/README
index fae0d68e..549d6fda 100644
--- a/README
+++ b/README
@@ -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 @@ Three tools are shipped with GObject Introspection:
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 @@ roundtrip tests (GIR -> typelib -> GIR).
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