diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6bfff19..cd1f405 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,13 +1,13 @@ # Contributing to the Render Engine Projects -Render Engine CLI is the CLI tool for the Render Engin static site generator. Please refer to +Render Engine CLI is the CLI tool for the Render Engine static site generator. Please refer to the main [CONTRIBUTING.md](https://github.com/render-engine/render-engine/blob/main/CONTRIBUTING.md) for more details on how to contribute. ## Render Engine CLI Specific Topics Render Engine CLI is a `uv` based project. For more information on installing `uv` and using it -please see the [uv documentation](https://docs.astral.sh/uv/#installation).To get started, for +please see the [uv documentation](https://docs.astral.sh/uv/#installation). To get started, for this repository and check out your fork. ```shell @@ -34,6 +34,6 @@ uv pip install . && uv pip install -e . **NOTE**: The above actually has you installing the CLI as uneditable and then as editable. This is only needed as long as the main Render Engine install includes an entry point as there is a conflict. The `uv pip install .` will overwrite the entry point for `render-engine` while the -second command, `uv pip insall -e .` will convert it to an editable install. +second command, `uv pip install -e .` will convert it to an editable install. This will allow you to test your changes via the command line.