From 93d6543ba94865acee1ea652ebfec9a4ee20e99f Mon Sep 17 00:00:00 2001
From: Riley V <fmtlinpqma@p.monash.edu>
Date: Tue, 2 Sep 2025 14:59:05 +1000
Subject: [PATCH] update readme with dev instructions

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 2bb5e5a..26496dc 100644
--- a/README.md
+++ b/README.md
@@ -104,6 +104,14 @@ proxy_username = kramer
 proxy_password = giddy up!
 ```
 
+Development environment setup
+======
+**Using a venv is strongly recommended**
+
+1. Clone the repository
+2. Navigate to the root folder where setup.py is present
+3. Create and activate a venv using your preferred tooling (e.g., VSCode Python Environments extension)
+4. Load the local copy of the library using `pip install -e .`
 
 License
 =======