soylent r244 - trunk/libsoylent

[svenp svn gnome org]

Author: svenp
Date: Sat Jul 26 12:59:45 2008
New Revision: 244
URL: http://svn.gnome.org/viewvc/soylent?rev=244&view=rev

Log:
added documentation and building notes to the README

Modified:
   trunk/libsoylent/README

Modified: trunk/libsoylent/README
==============================================================================
--- trunk/libsoylent/README	(original)
+++ trunk/libsoylent/README	Sat Jul 26 12:59:45 2008
@@ -25,6 +25,32 @@
  * Telepathy, Mission Control, libempathy
  * E-D-S
 
+--- Documentation ---
+
+The libsoylent API reference can be found online at:
+
+http://kalterregen.de/libsoylent
+
+It is also located in the source under the docs/references/libsoylent/html
+directory.
+
+--- Building libsoylent ---
+
+libsoylent uses autotools for building. To build libsoylent (and Soylent)
+execute in the source directory:
+
+./autogen.sh --enable-libsoylent=yes
+make
+
+If you want to install libsoylent (and Soylent) just do:
+
+make install
+
+If you also want to build the libsoylent documentation add --enable-gtk-doc to
+the autogen.sh parameters.
+
+That's it!
+
 --- Contact ---
 
 Bugs, feature requests, questions and related discussion go to the Soylent