Create README.md

ColoradoSchoolOfMines · Jun 9, 2023 · e22e922 · e22e922
1 parent f228f64
commit e22e922
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md 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)