From aa088fdd6f236c979be6bd85efb4d63076a95a4e Mon Sep 17 00:00:00 2001
From: Steven Murray <steven.g.murray@asu.edu>
Date: Mon, 19 May 2025 15:43:06 +0200
Subject: [PATCH] docs: add instructions for uv sync

---
 README.md | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9bc1062..ec2225e 100644
--- a/README.md
+++ b/README.md
@@ -19,4 +19,15 @@ The course textbook (in prep) is a [PDF here](/course_notes.pdf).
 
 ## Contributing
 
-please do.
\ No newline at end of file
+The best way to setup to write docs is to install the common environment using
+
+```bash
+uv sync
+```
+
+To install `uv` see [their documentation](https://docs.astral.sh/uv/getting-started/installation/),
+which generally boils down to:
+
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
\ No newline at end of file