Skip to content

Commit ac2d1ef

Browse files
committed
Add comments to python venv instructions
Signed-off-by: Jeff Goeders <[email protected]>
1 parent b444b90 commit ac2d1ef

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

BUILDING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Then to install the Python packages:
1818

1919
pip install -r requirements.txt
2020

21-
**Note:** If you chose to install the Python virtual environment, you will need to remember to activate it on any new terminal window you use, before you can run the VTR flow or regressions tests.
21+
**Note:** If you chose to install the Python virtual environment, you will need to remember to activate it on any new terminal window you use, before you can run the VTR flow or regressions tests (`source .venv/bin/activate`).
2222

2323
## Building
2424

doc/src/quickstart/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ VTR requires several system packages and Python packages to build and run the fl
2323
2424
> ./install_apt_packages.sh
2525
26-
Then, to install the required Python packages within a new virtual environment:
26+
Then, to install the required Python packages (optionally within a new Python virtual environment):
2727

2828
.. code-block:: bash
2929
30-
> make env
31-
> source .venv/bin/activate
32-
> pip install -r requirements.txt
30+
> make env # optional: install python virtual environment
31+
> source .venv/bin/activate # optional: activate python virtual environment
32+
> pip install -r requirements.txt # install python packages (in virtual environment if prior commands run, system wide otherwise)
3333
3434
3535
Build VTR

0 commit comments

Comments
 (0)