From 411629df3766f663067c9b193d780c9605da862c Mon Sep 17 00:00:00 2001 From: El RIDO Date: Sun, 19 Feb 2023 08:30:44 +0100 Subject: [PATCH] rename documentation files --- ...README.md => Generating Source Code Documentation.md} | 9 ++++----- INSTALL.md => doc/Installation.md | 4 +++- 2 files changed, 7 insertions(+), 6 deletions(-) rename doc/{README.md => Generating Source Code Documentation.md} (93%) rename INSTALL.md => doc/Installation.md (99%) diff --git a/doc/README.md b/doc/Generating Source Code Documentation.md similarity index 93% rename from doc/README.md rename to doc/Generating Source Code Documentation.md index d513ca34..0e9f1e0a 100644 --- a/doc/README.md +++ b/doc/Generating Source Code Documentation.md @@ -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 ``` - diff --git a/INSTALL.md b/doc/Installation.md similarity index 99% rename from INSTALL.md rename to doc/Installation.md index 26f8200f..3b2f6a2c 100644 --- a/INSTALL.md +++ b/doc/Installation.md @@ -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