diff --git a/docs/docs/about/contributing.md b/docs/docs/about/contributing.md index a366c68c0..82bad46db 100644 --- a/docs/docs/about/contributing.md +++ b/docs/docs/about/contributing.md @@ -23,11 +23,20 @@ We tag issues with the ["good first issue"](https://github.com/cocoindex-io/coco ## Start hacking! Setting Up Development Environment Following the steps below to get cocoindex build on latest codebase locally - if you are making changes to cocoindex funcionality and want to test it out. -- Install Rust toolchain: [docs](https://rust-lang.org/tools/install) +- 🦀 [Install Rust](https://rust-lang.org/tools/install) + + If you don't have Rust installed, run + ```bash + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh + ``` + Already have Rust? Make sure it's up to date + ```bash + rustup update + ``` -- (Optional) Setup Python virtual environment: +- (Recommended) Setup Python virtual environment: ```bash - virtualenv --python=$(which python3.12) .venv + python3 -m venv .venv ``` Activate the virtual environment, before any installings / buildings / runnings: