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
6d24ff824e
PrivateBin/doc/README.md
El RIDO f775da3931 fixing nasty deletion bug from #15, included unit tests to trigger it 
and reworked persistence classes to through exceptions rather to fail
silently
2015-08-27 21:41:21 +02:00

622 B
Raw Blame History

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 php-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/