From 1ad781a2495bcdeba2859817f4d7a3e86a66e6b7 Mon Sep 17 00:00:00 2001
From: MJ Rossetti <s2t2@users.noreply.github.com>
Date: Tue, 27 Aug 2024 13:03:48 -0400
Subject: [PATCH] Docs README

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

diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..45809a9
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,67 @@
+
+# Quarto Docs
+
+## Prerequisites
+
+### Quarto
+
+We need to install Quarto onto your local machine. You can [download](https://quarto.org/docs/get-started/), or [install via homebrew](https://formulae.brew.sh/cask/quarto) (if you like that kind of thing):
+
+```sh
+brew install --cask quarto
+```
+
+If you use VS Code, you can also consider installing the [Quarto Extension](https://marketplace.visualstudio.com/items?itemName=quarto.quarto).
+
+### Setup
+
+Fork the repo. Clone your copy of the repo onto your computer and navigate to it from the command line.
+
+Setup virtual environment:
+
+```sh
+conda create -n quarto-env python=3.10
+conda activate quarto-env
+```
+
+Install package dependencies:
+
+```sh
+#pip install -r requirements.txt
+pip install -r docs/requirements.txt
+```
+
+## Initialization
+
+FYI the following command was used to initialize the quarto config:
+
+```sh
+#quarto create book
+```
+
+In the docs/_quarto.yml file, the output directory was changed from _book to _build to standardize across projects, enabling the usage of common workflow files and makefile.
+
+## Building
+
+
+Previewing the site (runs like a local webserver):
+
+```sh
+quarto preview docs/
+```
+
+
+Rendering the site (writes local HTML files to the "docs/_build" directory, which is ignored from version control):
+
+```sh
+quarto render docs/ --verbose
+```
+
+
+## GitHub Actions Workflows
+
+### Website Publishing
+
+We are using the ["deploy.yml" workflow configuration file](/.github/workflows/deploy.yml) to deploy the site to GitHub Pages when new commits are pushed to the main branch.
+
+In order for this to work, you first need to configure your GitHub Pages repo settings to publish via GitHub Actions.