From 7f36df7054497f5733f97a5a5264ae3b5e2e5050 Mon Sep 17 00:00:00 2001 From: Alan Knowles Date: Tue, 6 Jul 2010 21:39:08 +0800 Subject: [PATCH] README.txt --- README.txt | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.txt diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..d57b208 --- /dev/null +++ b/README.txt @@ -0,0 +1,25 @@ +docs generator for gobject-introspection + +Requires seed + +run: +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 + +** 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