Skip to content

Commit af4c330

Browse files
Update readme
1 parent 3bd3db8 commit af4c330

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -454,7 +454,36 @@ exec $SHELL
454454
make sync-dev
455455
```
456456
457-
You can run the following tests:
457+
Running above commands should automatically setup the virtual environment for the project
458+
using the default system Python version and put it into the `.venv` folder under the project root.
459+
If you'd like to customize the Python version then run the following command before `make sync-dev`:
460+
461+
```bash
462+
uv venv --python <V>
463+
```
464+
465+
where `<V>` is the actual Python version, for example `3.12`.
466+
467+
If you want to customize the folder where uv stores the virtual environment by default
468+
(e.g. `.venv`) then add an argument containing the destination folder path to the above command:
469+
470+
```bash
471+
uv venv /venv/root/folder
472+
```
473+
474+
In order to activate the newly created virtual environment you may either source it:
475+
476+
```bash
477+
source /venv/root/folder/bin/activate
478+
```
479+
480+
or add it to PATH:
481+
482+
```bash
483+
export "PATH=/venv/root/folder/bin:$PATH"
484+
```
485+
486+
### Testing
458487
459488
#### Unit
460489

0 commit comments

Comments
 (0)