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)