Skip to content

Commit 0dcc360

Browse files
committed
Simplify running example configs instructions
1 parent dd35ec5 commit 0dcc360

File tree

1 file changed

+3
-13
lines changed

1 file changed

+3
-13
lines changed

examples/README.rst

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,26 +11,16 @@ To run Buildrunner using an example configuration file, follow these steps from
1111

1212
1. **Navigate to the Buildrunner repository directory.**
1313

14-
2. **Install Buildrunner:**
14+
2. **Execute Buildrunner with a specified configuration file:**
1515
.. code-block:: sh
1616
17-
pip install .
18-
19-
*Tip: It is recommended to install Buildrunner within a virtual environment to avoid conflicts with system-wide dependencies.*
20-
21-
22-
3. **Execute Buildrunner with a specified configuration file:**
23-
.. code-block:: sh
24-
25-
./bin/buildrunner -f examples/<path-to-config-file>
26-
or
27-
buildrunner -f examples/<path-to-config-file>
17+
PYTHONPATH=. ./bin/buildrunner -f examples/<path-to-config-file>
2818
2919
*Example:*
3020

3121
.. code-block:: sh
3222
33-
buildrunner -f examples/configs/build/basic/buildrunner.yaml
23+
PYTHONPATH=. ./bin/buildrunner -f examples/build/basic/buildrunner.yaml
3424
3525
Adding a New Example Configuration File
3626
=======================================

0 commit comments

Comments
 (0)