JSDOC/TokenReader.js

[gnome.introspection-doc-generator] / README.txt

diff --git a/README.txt b/README.txt
index 1508b5d..f2c5bcf 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -2,17 +2,33 @@ docs generator for gobject-introspection
 
 Requires seed
 
+-----------------------------
+
+Known issues:
+GArgument does not get exported correctly by introspection.
+
+Use the girepository.gir from here..
+https://github.com/roojs/gir-1.2-gtk-3.0/blob/master/GIRepository-2.0.gir
+g-ir-compile GIRepository-2.0.gir -o GIRepository-2.0.typelib
+
+make a copy of /usr/lib/girepoistory-1.0/GIRepository-2.0.typelib
+copy that over it.
+
+
+
+-----------------------------
+
+
 run:
-seed docs.js
+seed docs.js /var/www
 
 outputs to /var/www/seed
+** if you have templates for other languages they will be output into /var/www/LANG 
 
 ----------------------------
 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.!
 ---------------------------