From 457230046f4b7e6dff14e5f664790a39d577fda7 Mon Sep 17 00:00:00 2001 From: Alan Knowles Date: Fri, 19 Mar 2010 07:21:18 +0800 Subject: [PATCH] Add some notes so some of this makes sense Include licence details / run instructions etc. --- README.txt | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.txt 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..) + + -- 2.39.2