From e22e922c21b21af189a6a8a2703d9dd2c6c09135 Mon Sep 17 00:00:00 2001
From: Ethan Richards <42894274+ezrichards@users.noreply.github.com>
Date: Thu, 8 Jun 2023 19:03:58 -0600
Subject: [PATCH] Create README.md

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..733d0df
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# coloradoschoolofmines.github.io
+A wiki for all CS@Mines clubs.
+
+## Local Setup
+
+First, install the theme via pip:
+`pip install -r requirements.txt`
+
+Then, run: `make html` to make the website.
+The generated site should be located in `_build/html/index.html`
+
+## Useful Links
+- [Sphinx to GitHub Pages V3](https://github.com/marketplace/actions/sphinx-to-github-pages)
+- [Furo Theme](https://github.com/pradyunsg/furo)
+- [RST Cheatsheet](https://github.com/pradyunsg/furo)