From: Alan Knowles <alan@akkbhome.com>
Date: Thu, 18 Mar 2010 23:21:18 +0000 (+0800)
Subject: Add some notes so some of this makes sense
X-Git-Url: http://git.roojs.org/?p=gnome.introspection-doc-generator;a=commitdiff_plain;h=457230046f4b7e6dff14e5f664790a39d577fda7

Add some notes so some of this makes sense

Include licence details / run instructions etc.
---

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..1508b5d
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,26 @@
+docs generator for gobject-introspection
+
+Requires seed
+
+run:
+seed docs.js
+
+outputs to /var/www/seed
+
+----------------------------
+Licence:
+JSDOC code based on http://code.google.com/p/jsdoc-toolkit/ : MIT Licence
+Introspection - LGPL 
+Roo - Based on RooJS / Forked from LGPL version of ExtJS - Licence LGPL
+anything else - LGPL
+
+** FIXME - put the licence headers in the code.!
+---------------------------
+
+TODO list:
+- Work out how to host the bugger..
+- More libraries (related to gobject-introspection hacking)
+- Better documentation - we probably have to manually generate GIR's from source for this, as we have a 'special' doc requirement
+- add gir builder script (chroot/jhbuild..)
+
+