From 236b714bc6e2ad3d425eba786406afe5e413b189 Mon Sep 17 00:00:00 2001
From: Christopher Carroll Smith <chriscarrollsmith@gmail.com>
Date: Thu, 14 Nov 2024 16:45:45 -0500
Subject: [PATCH] Minor adjustments to documentation for contributors

---
 .github/workflows/dev.yml |  2 +-
 README.md                 | 10 +++++++++-
 2 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/dev.yml b/.github/workflows/dev.yml
index f070689..d918b89 100644
--- a/.github/workflows/dev.yml
+++ b/.github/workflows/dev.yml
@@ -55,4 +55,4 @@ jobs:
       - name: Commit and push changes to repository
         uses: stefanzweifel/git-auto-commit-action@v5
         with:
-          commit_message: 'Automated code format and README render'
\ No newline at end of file
+          commit_message: 'Automated code format'
\ No newline at end of file
diff --git a/README.md b/README.md
index 68f953d..a65939d 100644
--- a/README.md
+++ b/README.md
@@ -51,7 +51,11 @@ We welcome contributions to improve `imfp`! Here's how you can help:
    - Create a fix
    - Open a pull request to the `dev` branch
 
-For maintainers: To deploy a new version:
+Note that you will need to install the [Poetry](https://python-poetry.org/docs/#installation) package manager to install the dependencies and run the tests, and the [Quarto CLI tool](https://quarto.org/docs/download/) to render the documentation.
+
+## Maintainers
+
+To deploy a new version:
 1. Increment version with `poetry version patch/minor/major`
 2. Update dependencies with `poetry update`
 3. Run tests with `pytest tests`
@@ -59,4 +63,8 @@ For maintainers: To deploy a new version:
 5. Push to dev
 6. Open PR to main
 
+To render and deploy documentation:
+1. `quarto render`
+2. `quarto publish`
+
 The GitHub Actions workflow will handle code formatting, testing, and deployment to PyPI after merge.
\ No newline at end of file