Skip to content

Commit 07c4b8b

Browse files
committed
Add note about local editable installation to CONTRIBUTING.md
1 parent 4571142 commit 07c4b8b

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,13 @@ that you do a local, editable install of the CLI in your virtual environment so
2727
work with the changes you have made.
2828

2929
```shell
30-
uv pip install -e .
30+
31+
uv pip install . && uv pip install -e .
3132
```
3233

34+
**NOTE**: The above actually has you installing the CLI as uneditable and then as editable. This
35+
is only needed as long as the main Render Engine install includes an entry point as there is a
36+
conflict. The `uv pip install .` will overwrite the entry point for `render-engine` while the
37+
second command, `uv pip insall -e .` will convert it to an editable install.
38+
3339
This will allow you to test your changes via the command line.

0 commit comments

Comments
 (0)