cvs: livedocs / README

goba Sun Jan 11 08:43:44 2004 EDT Modified files: /livedocs README Log: better introduction, license and credits information, plus some typo fixes Index: livedocs/README diff -u livedocs/README:1.5 livedocs/README:1.6 --- livedocs/README:1.5 Sun Jan 11 07:27:20 2004 +++ livedocs/README Sun Jan 11 08:43:44 2004 @@ -1,7 +1,30 @@ -$Id: README,v 1.5 2004/01/11 12:27:20 nlopess Exp $ +$Id: README,v 1.6 2004/01/11 13:43:44 goba Exp $ vim:et:tw=78 -"LiveDocs" - a work in progress +INTRODUCTION +------------ + +Livedocs is a tool to display DocBook XML files on the fly, +instead of building all the HTML files first. There is a little +preprocessing work needed, but otherwise the script collection +works instantly even on modified XML files. This tool is primarily +aimed at solving the PHP documentation efforts problems, but it is +meant to be general enough to handle all the various documentation +styles and methods we have. + +LICENSE +------- + +Livedocs is available under the PHP License 3.0. More information +about the license is available at http://www.php.net/license/ + +CREDITS +------- + + Wez Furlong, Derick Rethans, Ilia Alshanetsky + +INSTALL +------- 1. Update your phpdoc checkout: @@ -31,11 +54,11 @@ ./build.sh This creates phpdoc-idx.$LANG.sqlite and livedoc-cache-idx.$LANG.sqlite. - It will also configures the phpdoc (autoconf & ./configure). + It will also configure phpdoc (autoconf & ./configure). 3. Call up a node in your browser - http://localhost/lievdocs/index.php?q=function.fopen + http://localhost/livedocs/index.php?q=function.fopen Done :)