Infra-Mirrors/PrivateBin
1
0
Fork 0
mirror of https://github.com/PrivateBin/PrivateBin.git synced 2024-10-01 01:26:10 -04:00
Code Issues Packages Projects Releases Wiki Activity

rename documentation files

Browse Source
This commit is contained in:
El RIDO 2023-02-19 08:30:44 +01:00
parent 9a65b8e72b
commit 411629df37
2 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/README.md → doc/Generating Source Code Documentation.md
View File

@ -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 In order to generate the documentation, you will need to install the following
packages and its dependencies: 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) [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. 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 In order to generate the documentation, you will need to install the following
packages and its dependencies: packages and its dependencies:
@ -57,4 +57,3 @@ To generate the documentation, change into the main directory and run phpdoc:
$ cd PrivateBin $ cd PrivateBin
$ jsdoc -p -d doc/jsdoc js/privatebin.js js/legacy.js $ jsdoc -p -d doc/jsdoc js/privatebin.js js/legacy.js
``` ```

4
INSTALL.md → doc/Installation.md
View File

@ -1,6 +1,8 @@
# Installation # Installation
**TL;DR:** Download the ## TL;DR
Download the
[latest release archive](https://github.com/PrivateBin/PrivateBin/releases/latest) [latest release archive](https://github.com/PrivateBin/PrivateBin/releases/latest)
(with the link labelled as "Source code (…)") and extract it in your web hosts (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 folder where you want to install your PrivateBin instance. We try to provide a