Skip to content

Commit fbb01bf

Browse files
committed
Update README files
1 parent 0bae85d commit fbb01bf

File tree

2 files changed

+14
-10
lines changed

2 files changed

+14
-10
lines changed

README.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1128,6 +1128,11 @@ Common Issues
11281128

11291129
See `docs/common-issues <docs/common-issues.rst>`_.
11301130

1131+
Example Configurations
1132+
======================
1133+
1134+
See `examples <examples/README.rst>`_.
1135+
11311136
Contributing
11321137
============
11331138

examples/README.rst

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,23 +11,22 @@ 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 (Recommended: Use a Virtual Environment)**
14+
2. **Install Buildrunner:**
15+
.. code-block:: sh
1516
16-
It is recommended to install Buildrunner within a virtual environment to avoid conflicts with system-wide dependencies.
17+
pip install .
1718
18-
.. code-block:: sh
19+
*Tip: It is recommended to install Buildrunner within a virtual environment to avoid conflicts with system-wide dependencies.*
1920

20-
pip install .
2121

2222
3. **Execute Buildrunner with a specified configuration file:**
23+
.. code-block:: sh
2324
24-
.. code-block:: sh
25-
26-
./bin/buildrunner -f examples/<path-to-config-file>
25+
./bin/buildrunner -f examples/<path-to-config-file>
2726
28-
For example:
27+
*Example:*
2928

30-
.. code-block:: sh
29+
.. code-block:: sh
3130
3231
./bin/buildrunner -f examples/configs/build/basic/buildrunner.yaml
3332
@@ -48,4 +47,4 @@ To contribute a new example configuration file, adhere to the following guidelin
4847
- If necessary, include a ``README.rst`` file in the same directory as the configuration file to provide additional details or instructions.
4948
- Any supporting files required for the configuration should be placed alongside the configuration file.
5049

51-
Following these best practices ensures consistency, maintainability, and ease of use for all contributors and users.
50+
Following these best practices ensures consistency, maintainability, and ease of use for all contributors and users.

0 commit comments

Comments
 (0)