StarMirror/PrivateBin
1
0
Fork 0
mirror of https://github.com/PrivateBin/PrivateBin.git synced 2024-03-22 13:10:41 +08:00
Code Issues Projects Releases Wiki Activity
aa3eba9b1f
PrivateBin/doc
History
El RIDO 24d18c5313 cleaned up phpdoc comments, added README on how to install and use it
2015-08-16 15:55:31 +02:00
..
README.md cleaned up phpdoc comments, added README on how to install and use it 2015-08-16 15:55:31 +02:00

README.md

Generating documentation

In order to generate the documentation, you will need to install the following packages and its dependencies:

  • phpdoc
  • graphviz

Details about installing phpDocumentor can be found in its own documentation.

Example for Debian and Ubuntu: $ sudo aptitude install pear graphviz $ sudo pear channel-discover pear.phpdoc.org $ sudo pear install phpdoc/phpDocumentor

To generate the documentation, change into the main directory and run phpdoc: $ cd ZeroBin $ phpdoc -d lib/ -t doc/