Infra-Mirrors/PrivateBin
1
0
Fork 0
mirror of https://github.com/PrivateBin/PrivateBin.git synced 2024-12-11 16:54:20 -05:00
Code Issues Packages Projects Releases Wiki Activity
e49e1e2079
PrivateBin/doc
History
El RIDO 79509ad48a renaming the fork to PrivateBin
2016-07-11 11:58:15 +02:00
..
README.md renaming the fork to PrivateBin 2016-07-11 11:58:15 +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 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 PrivateBin
$ phpdoc -d lib/ -t doc/