Skip to content

Commit

Permalink
Simplify running example configs instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
shanejbrown committed Feb 21, 2025
1 parent dd35ec5 commit 0dcc360
Showing 1 changed file with 3 additions and 13 deletions.
16 changes: 3 additions & 13 deletions examples/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,26 +11,16 @@ To run Buildrunner using an example configuration file, follow these steps from

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

2. **Install Buildrunner:**
2. **Execute Buildrunner with a specified configuration file:**
.. code-block:: sh
pip install .
*Tip: It is recommended to install Buildrunner within a virtual environment to avoid conflicts with system-wide dependencies.*


3. **Execute Buildrunner with a specified configuration file:**
.. code-block:: sh
./bin/buildrunner -f examples/<path-to-config-file>
or
buildrunner -f examples/<path-to-config-file>
PYTHONPATH=. ./bin/buildrunner -f examples/<path-to-config-file>
*Example:*

.. code-block:: sh
buildrunner -f examples/configs/build/basic/buildrunner.yaml
PYTHONPATH=. ./bin/buildrunner -f examples/build/basic/buildrunner.yaml
Adding a New Example Configuration File
=======================================
Expand Down

0 comments on commit 0dcc360

Please sign in to comment.