From 030a932c4e04e08f5259fe1172ab989ffc908c26 Mon Sep 17 00:00:00 2001 From: Shane Brown Date: Mon, 10 Mar 2025 15:01:57 -0600 Subject: [PATCH] Update examples README files --- README.rst | 2 +- examples/README.rst | 10 ++++++++-- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 78e09bd..5cd89a0 100755 --- a/README.rst +++ b/README.rst @@ -1131,7 +1131,7 @@ See `docs/common-issues `_. Example Configurations ====================== -See `examples `_. +See `examples/ `_. Contributing ============ diff --git a/examples/README.rst b/examples/README.rst index 4fa4b0e..bf9280d 100644 --- a/examples/README.rst +++ b/examples/README.rst @@ -11,12 +11,18 @@ To run Buildrunner using an example configuration file, follow these steps from 1. **Navigate to the Buildrunner repository directory** -2. **Install Buildrunner Requirements** +2. **Create a virtual environment** (Recommended)** + .. code-block:: sh + + python -m venv .venv + source .venv/bin/activate + +3. **Install Buildrunner Requirements** .. code-block:: sh pip install -r requirements.txt -3. **Execute Buildrunner with a specified configuration file:** +4. **Execute Buildrunner with a specified configuration file:** .. code-block:: sh ./run-buildrunner.sh -f examples/