From 01126edc4e3174a7ca4f17eb8e622e9e43409d9a Mon Sep 17 00:00:00 2001
From: LoafyLemon <loafylemon@gmail.com>
Date: Wed, 2 Aug 2023 22:00:18 +0100
Subject: [PATCH] Update README

---
 README.md | 120 ++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 95 insertions(+), 25 deletions(-)

diff --git a/README.md b/README.md
index 5b57eb2f..a30fd7fb 100644
--- a/README.md
+++ b/README.md
@@ -1,38 +1,108 @@
-![# Witch Trainer: Silver](https://1.bp.blogspot.com/--t9cxuok8JU/YUurd9fYbLI/AAAAAAAAABc/EbEFemd0TxUXoiQVeDArIY7hmCQPVw1jACNcBGAsYHQ/w400-h278/title.png)
+<a name="user-content-readme-top"></a>
+<div align="center">
+  <a href="https://dev.silverstudiogames.org">
+    <img src="/assets/logo.webp" alt="Logo">
+  </a>
 
-This repository contains all of the game's source code. If you are searching for the most recent stable build, please [visit our website's download page](https://www.silverstudiogames.org/p/download.html) instead.
+  <p align="center">
+    A complete repository for more than just Hermione's backend.
+    <br />
+    <a href="https://www.silverstudiogames.org/wiki"><strong>Explore the wiki »</strong></a>
+    <br />
+    <br />
+    <a href="https://www.silverstudiogames.org/faq">FAQ</a>
+    ·
+    <a href="https://discord.gg/uYepjNPEsu">Report Bug</a>
+    ·
+    <a href="https://discord.gg/xCBDEnDb4w">Request Feature</a>
+  </p>
+</div>
 
-The development takes place on the `dev` branch, and occasionally on feature branches, `main` branch is reserved for game releases.
+<!-- GETTING STARTED -->
+## Getting Started
 
-# Developers:
-Johnny28, LoafyLemon, Boppin
+* **`dev`:** Active development occurs primarily on this branch, and occasionally on feature branches.
+* **`current`:** This branch is dedicated to patches for the current public version.
+* **`main`:** The main branch is exclusively for finalized game releases.
 
-# Contributors:
-MaiL, Mo, UE CatBug, Lineup, Soggy, Asease1, Linear, Lupin, Techy, Dr. Noodle, MadMerlin, DostojevskijSTG, STG Artguy, Crew, Ven, perniciousducks, Cleanzo, Darwin7, Pinguino, Sandmaster, Amadan, Heretic, Maverick, Anon, MedicBear, TropeCode, Booom313, CaptainNemo, and anonymous.
+## Prerequisites
 
-# Requirements:
-* Renpy 7.5+
-* Python 2.7
+<details>
+  <summary>Windows</summary>
+  <ol>
+    <li><a href="https://www.renpy.org/release/8.1.1" target="_blank">Download and install Ren'py SDK</a></li>
+    <li><a href="https://gitforwindows.org/" target="_blank">Download and install git</a></li>
+  </ol>
+</details>
 
-# Documentation
-TBD
+<details>
+  <summary>Debian</summary>
 
-# Translating
-TBD
+### Install Ren'Py SDK
+<pre><code>curl -o renpy-sdk.tar.bz2 https://www.renpy.org/dl/8.1.1/renpy-8.1.1-sdk.tar.bz2
+tar -xjf renpy-sdk.tar.bz2
+mv renpy-8.1.1-sdk /opt/renpy
+chmod +x /opt/renpy/renpy.sh
+echo "alias renpy=/opt/renpy/renpy.sh" >> ~/.bashrc
+source ~/.bashrc</code></pre>
 
-# FAQ:
+### Install GIT, GIT-LFS
+<pre><code>sudo apt install git git-lfs
+git lfs install</code></pre>
+  </summary>
+</details>
 
-#### Where can I support Witch Trainer: Silver?
-You can support us on [patreon](https://www.patreon.com/SilverStudioGames).
+## Installation
 
-#### I have found a bug, how do I report it?
-Please make a report on the [discord](https://discord.gg/UbQeTCJ5RW).
+<details>
+  <summary>Windows</summary>
+  <ol>
+    <li>Clone the repository:
+      <pre><code>git clone https://dev.silverstudiogames.org/SilverStudioGames/WTS.git</code></pre>
+    </li>
+  <li>Run Ren'py Launcher.</li>
+  <li>Hit preferences and select the directory where the project is located.</li>
+  <li>Hit return and click on 'Launch Project'.</li>
+  </ol>
+</details>
 
-#### Can I receive access to the issue tracker?
-Yes, upon review we may grant you access to the repository. Contact us on [discord](https://discord.gg/UbQeTCJ5RW) for details.
+<details>
+  <summary>Debian</summary>
+<pre><code>git clone https://dev.silverstudiogames.org/SilverStudioGames/WTS.git
+renpy WTS</code></pre>
+  </summary>
+</details>
 
-#### Can I make a pull request?
-Bug fixes and enhancements are welcome, but content submissions must be thoroughly evaluated before they are accepted.
+## Build
 
-#### Why is the registration closed?
-Our server resources are limited, we need to conserve them. We may re-open registration in the future.
+<details>
+  <summary>Windows</summary>
+Navigate the GUI in Ren'Py launcher for packaging purposes.
+</details>
+<details>
+  <summary>Debian</summary>
+<pre><code>renpy /opt/renpy/launcher distribute WTS --package pc</pre></code>
+</details>
+
+## License
+Source code distributed under the LGPL-3.0 license. See [LICENSE](LICENSE) for more information.
+
+## Active Developers:
+- LoafyLemon - Lead Developer
+- Johnny28 - Lead Writer
+- Boppin - Lead Artist
+
+## Contributors:
+- MaiL, Mo, UE CatBug, Lineup, Soggy, Asease1, Linear, Lupin, Techy, Dr. Noodle
+- MadMerlin, DostojevskijSTG, STG Artguy, Crew, Ven, perniciousducks, Cleanzo, Darwin7
+- Pinguino, Sandmaster, Amadan, Heretic, Maverick, Anon, MedicBear, TropeCode, Booom313
+- CaptainNemo, NotTera, Armise, Cosmic and anonymous.
+
+<div align="center" style="margin=20px;">
+  <a href="https://www.silverstudiogames.org">
+    <img src="/assets/org.webp" alt="Silver Studio Games logo">
+    <h3>Silver Studio Games</h3>
+  </a>
+</div>
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>