1
0
Prechádzať zdrojové kódy

Add developer documentation

Sunny 2 rokov pred
rodič
commit
7c32bd1cbc
3 zmenil súbory, kde vykonal 21 pridanie a 8 odobranie
  1. 20 0
      README.md
  2. 1 1
      config/config.php
  3. 0 7
      pages/index.php

+ 20 - 0
README.md

@@ -0,0 +1,20 @@
+# Tent
+
+Tent is a simple alternative front-end for Bandcamp.
+
+For end-user documentation, see the home page of an instance of your choice.
+
+## Instances
+
+- https://tent.sny.sh/
+
+## Setup
+
+1. Install PHP.
+2. Install PHP's curl and dom extensions.
+3. Clone the repository and its submodules.
+4. Point your server to `pages`.
+
+## License
+
+Tent is licensed under the [Blue Oak Model License 1.0.0](https://blueoakcouncil.org/license/1.0.0).

+ 1 - 1
config/config.php

@@ -1,6 +1,6 @@
 <?php
   $config = [
     "title" => "Tent",
-    "text" => "© 2023-present, Sunny. Not affiliated with Bandcamp. Licensed under the Blue Oak Model License."
+    "text" => "© 2023-present, Sunny. Not affiliated with Bandcamp. Open-source at <a href=\"https://codeberg.org/sun/Tent\">Codeberg</a>."
   ];
 ?>

+ 0 - 7
pages/index.php

@@ -42,11 +42,4 @@
   <li><code>https://f4.bcbits.com/img/$1</code> → <code><?= $url ?>image.php?file=$1</code></li>
 </ul>
 
-<h2>Is Tent open-source?</h2>
-<p>
-  Tent's source code can be found at <a href="https://codeberg.org/sun/Tent">Codeberg</a>.
-  <br>
-  To run it, download the repository, install <a href="https://www.php.net/">PHP</a> and its cURL and XML extensions and point your server to <code>pages</code>.
-</p>
-
 <?php include "../elements/footer.php" ?>