Kaynağa Gözat

rename documentation files

El RIDO 3 yıl önce
ebeveyn
işleme
411629df37

+ 4 - 5
doc/README.md → 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
 ```
-

+ 3 - 1
INSTALL.md → 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