nlopess Sun Jan 11 07:27:20 2004 EDT
Modified files:
/livedocs README
Log:
better explanation
Index: livedocs/README
diff -u livedocs/README:1.4 livedocs/README:1.5
--- livedocs/README:1.4 Wed Jun 18 11:32:37 2003
+++ livedocs/README Sun Jan 11 07:27:20 2004
@@ -1,14 +1,11 @@
-$Id: README,v 1.4 2003/06/18 15:32:37 wez Exp $
+$Id: README,v 1.5 2004/01/11 12:27:20 nlopess Exp $
vim:et:tw=78
"LiveDocs" - a work in progress
1. Update your phpdoc checkout:
- cvs co -d... phpdoc
- cd phpdoc
- autoconf
- ./configure
+ cvs -d :pserver:[EMAIL PROTECTED]:/repository checkout phpdoc
2. Ensure that your php has sqlite support
@@ -19,24 +16,26 @@
3. Configure livedocs!
cd livedocs
- ./buildconf
+ autoconf
Read the available options:
./configure --help
-2. Run the livedoc indexer:
+ example:
+ ./configure --with-build-log=log.txt --with-docs=/cvs/phpdoc
+ --enable-content-caching=yes --with-output-dir=/home/httpd/livedocs
- php mkindex.php /path/to/phpdoc en
+2. Run the livedoc indexer:
- This creates phpdoc-idx.sqlite in the working directory.
+ ./build.sh
-3. Put the content-renderer and the CSS file in your web space
+ This creates phpdoc-idx.$LANG.sqlite and livedoc-cache-idx.$LANG.sqlite.
+ It will also configures the phpdoc (autoconf & ./configure).
- cp livedoc.php livedoc.css ~/public_html
3. Call up a node in your browser
- http://localhost/~wez/livedoc.php?q=function.fopen
+ http://localhost/lievdocs/index.php?q=function.fopen
Done :)
