mirror of
https://github.com/PrivateBin/PrivateBin.git
synced 2024-10-01 01:26:10 -04:00
20 lines
618 B
Markdown
20 lines
618 B
Markdown
|
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](http://phpdoc.org/docs/latest/getting-started/installing.html)
|
||
|
|
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/
|