mirror of
https://github.com/PrivateBin/PrivateBin.git
synced 2024-10-01 01:26:10 -04:00
rename documentation files
This commit is contained in:
parent
9a65b8e72b
commit
411629df37
@ -1,5 +1,6 @@
|
||||
Generating PHP documentation
|
||||
============================
|
||||
# Generating Source Code Documentation
|
||||
|
||||
## Generating PHP documentation
|
||||
|
||||
In order to generate the documentation, you will need to install the following
|
||||
packages and its dependencies:
|
||||
@ -28,8 +29,7 @@ manually installed by downloading it from
|
||||
[GitHub](https://github.com/phpDocumentor/phpDocumentor2/releases/download/v2.9.0/phpDocumentor.phar)
|
||||
and then manually moving it to e.g. `/usr/local/bin` and making it executable.
|
||||
|
||||
Generating JS documentation
|
||||
============================
|
||||
## Generating JS documentation
|
||||
|
||||
In order to generate the documentation, you will need to install the following
|
||||
packages and its dependencies:
|
||||
@ -57,4 +57,3 @@ To generate the documentation, change into the main directory and run phpdoc:
|
||||
$ cd PrivateBin
|
||||
$ jsdoc -p -d doc/jsdoc js/privatebin.js js/legacy.js
|
||||
```
|
||||
|
@ -1,6 +1,8 @@
|
||||
# Installation
|
||||
|
||||
**TL;DR:** Download the
|
||||
## TL;DR
|
||||
|
||||
Download the
|
||||
[latest release archive](https://github.com/PrivateBin/PrivateBin/releases/latest)
|
||||
(with the link labelled as "Source code (…)") and extract it in your web hosts
|
||||
folder where you want to install your PrivateBin instance. We try to provide a
|
Loading…
Reference in New Issue
Block a user