removed mods directory from the ATutor codebase
[atutor.git] / mods / phpdoc2 / PhpDocumentor / INSTALL
diff --git a/mods/phpdoc2/PhpDocumentor/INSTALL b/mods/phpdoc2/PhpDocumentor/INSTALL
deleted file mode 100644 (file)
index 39d3401..0000000
+++ /dev/null
@@ -1,81 +0,0 @@
-$Id: INSTALL,v 1.3 2007/02/07 20:06:44 ashnazg Exp $\r
-\r
-phpDocumentor Installation instructions\r
----------------------------------------\r
-\r
-phpDocumentor is very easy to install.  The hardest part is installing PHP\r
-and possibly a Web Server, if you plan to use the web interface phpdoc.php.\r
-\r
-To install phpDocumentor, use a compression program to decompress the\r
-contents to a directory, preserving internal directory structure of the\r
-archive.  If you wish to use the web interface, you must unzip the\r
-archive into a subdirectory accessible by the web server.\r
-\r
-NOTE:\r
-There have been problems with the non GNU tar not being able to extracts some\r
-of the long directory paths properly.  The simplest solution for BSD users is\r
-to download the zip version of phpDocumentor.\r
-\r
-PEAR installation\r
------------------\r
-This is by far the easiest way to install phpDocumentor.  Included in this\r
-release is a package.xml file.\r
-\r
-If you plan to use the web interface, you must run this command prior to installation:\r
-\r
-pear config-set data_dir /path/to/public_html/pear\r
-\r
-The line above assumes that /path/to/public_html is the location of index.html if you browse\r
-to http://localhost/index.html\r
-\r
-To install or upgrade phpDocumentor, simply run\r
-\r
-pear upgrade PhpDocumentor\r
-\r
-To use the web interface, browse to http://localhost/pear/PhpDocumentor/index.html\r
-\r
-The cli interface is installed in the pear bin_dir, you can find this directory by running:\r
-pear config-show\r
-\r
-Command-line interface installation and usage instructions\r
-----------------------------------------------------------\r
-To use phpDocumentor as a command-line interface, you need to install PHP\r
-version 4.1.0 or greater.\r
-\r
-*IMPORTANT* any version of PHP below 4.1.0 will not work with version 1.3.0 or later of\r
-phpDocumentor!!!  To use the advanced tokenizer-based parser, you must have php 4.3.0\r
-\r
-Windows\r
--------\r
-You need the cli version of PHP (php-cli.exe or cli/php.exe in 4.3.0+).\r
-Either run phpDocumentor from the directory that PHP resides in, or put\r
-php.exe in your DOS PATH enviroment variable.  The simplest usage of phpDocumentor is:\r
-\r
-C:\>php.exe "C:\Path\To\phpdoc" -t targetdir -o HTML:default:default -d parsedir\r
-\r
-where targetdir is the directory you wish phpDocumentor to create output,\r
-and parsedir is the directory you wish to parse.\r
-\r
-Unix\r
-----\r
-Make sure that the cgi/cli version of PHP is in your path.  The simplest usage\r
-of phpDocumentor is:\r
-\r
-phpdoc -t targetdir -o HTML:default:default -d parsedir\r
-\r
-You can also use makedoc.sh. Simply copy it to your project path and edit it.\r
-When you wish to (re)build your project's documentation, simply run it.\r
-\r
-\r
-Web interface installation and usage instructions\r
--------------------------------------------------\r
-To use phpDocumentor as a web interface, you need to install a Web server\r
-and configure it, as well as install PHP version 4.1.0 or greater.  Consult\r
-the documentation of your webserver and of PHP for installation support.\r
-\r
-Windows and Unix\r
-----------------\r
-Open a web browser and browse to phpdoc.php at the location that you set up.\r
-Instructions are in the web interface.\r
-\r
-vim: set expandtab :\r