From ba55cfd4727213ac87af7438b9fd4d331e56bf82 Mon Sep 17 00:00:00 2001
From: southerntofu <southerntofu@thunix.net>
Date: Wed, 28 Jul 2021 19:43:31 -0400
Subject: [PATCH] Update the README

---
 README.md | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 4994ad3..4e8999d 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-### SimpleerTube
+# SimpleerTube
 
 Active Known Instances:
 - https://simpleertube.metalune.xyz
@@ -11,3 +11,29 @@ If you want to visit any page from your PeerTube instance of choice in SimpleerT
 So, `https://videos.lukesmith.xyz/accounts/luke` becomes `https://simpleertube.metalune.xyz/videos.lukesmith.xyz/accounts/luke`.
 
 If you visit the main page, you can search globally (it uses [Sepia Search](https://sepiasearch.org) in the backend).
+
+## Setup
+
+You need to setup a few dependencies first, usually using pip (`sudo apt install python3-pip` on Debian):
+
+```
+$ sudo pip3 install quart bs4 html2text lxml
+```
+
+**Note:** If there are other dependencies that are not packaged with your system, please report them to us so they can be added to this README.
+
+Now you can run a development environment like so:
+
+```
+$ python3 main.py # Starts on localhost:5000
+$ python3 main.py 192.168.42.2 # Starts on 192.168.42.2:5000
+$ python3 main.py 7171 # Starts on localhost:7171
+$ python3 main.py 192.168.42.2 7171 # Starts on 192.168.42.2:7171
+$ python3 main.py ::1 7171 # Also works with IPv6 addresses
+```
+
+It is strongly disrecommended to run the production using this command. Instead, please refer to the [Quart deployment docs](https://pgjones.gitlab.io/quart/tutorials/deployment.html).
+
+## License
+
+This software is distributed under the AGPLv3 license. You can find a copy in the [LICENSE](LICENSE) file.