From: Damian Myrda <monkey.damianek@gmail.com>
Date: Wed, 24 Apr 2024 19:47:59 +0000 (-0500)
Subject: Update README
X-Git-Url: http://git.prime8.dev/?a=commitdiff_plain;h=681a61a70e82365ced497a7a0a027fe3d0c4431b;p=csc.git

Update README
---

diff --git a/README.md b/README.md
index bf10c72..956dfd2 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,9 @@
 # computer_science_club
-A website for Computer Science Club.
+A website for Computer Science Club. It was made during a mini-hackathon.
+
+## setup
+To setup the server environment, run ```python -m venv .``` in the root of the project. Then, execute ```. ./bin/activate``` and you should be in the virtual environment. Lastly, run ```pip install flask schoolopy``` to install all the dependencies. Now, exit using by running ```exit```.
+
+## running
+To run the server, execute ```run.sh```.
+
diff --git a/run.sh b/run.sh
new file mode 100755
index 0000000..b8861ec
--- /dev/null
+++ b/run.sh
@@ -0,0 +1,2 @@
+. ./bin/activate
+flask --app main.py run