From 9f80e81e890e0efa12476f1e90523371865a8d23 Mon Sep 17 00:00:00 2001
From: Josh Creek <8179928+jcreek@users.noreply.github.com>
Date: Sun, 24 Sep 2023 15:45:30 +0100
Subject: [PATCH] docs(*): Add readme

---
 README.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2863a46..e8c855d 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,21 @@
-# Sarpy
\ No newline at end of file
+# Sarpy
+
+## Prerequisites
+
+1. Install Visual C++ 14.0 or greater from https://visualstudio.microsoft.com/visual-cpp-build-tools/
+2. Run `pip install setuptools==65.5.0 pip==21` as gym 0.21 installation is broken with more recent versions
+3. You can now install the packages manually or using the requirements.txt file. To do the latter, run `pip3 install -r requirements.txt`
+
+### Manual package installation
+
+You will likely see errors during installations here. Largely these should be ignored, just try running things after installing, then work out manually what is broken. There are lots of deprecated or broken packages involved in running rlgym unfortunately, as it does not support the newer version 2 of stable baselines 3 that uses gymnasium instead of gym.
+
+1. Run `pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu117`
+2. Run `pip3 install "stable-baselines3[extra]==1.8.0"`
+3. Run `pip3 install "gym[box2d]"`
+
+## Other useful commands
+
+`tensorboard --logdir=logs` in a new terminal to load the web UI to track agent training.
+
+`pip3 freeze > requirements.txt` to save current packages installed into an updated requirements.txt file.