From 84b2a02e009cd499e2146ca16cd417b2015e3fa6 Mon Sep 17 00:00:00 2001 From: CocoIndex Dev Date: Thu, 27 Mar 2025 11:42:57 -0700 Subject: [PATCH 1/4] Update contributing.md --- docs/docs/about/contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/about/contributing.md b/docs/docs/about/contributing.md index a97802a2..90acf9eb 100644 --- a/docs/docs/about/contributing.md +++ b/docs/docs/about/contributing.md @@ -22,7 +22,7 @@ We love contributions from our community! This guide explains how to get involve pip install maturin ``` -- Build the library +- Build the library. In the same virtual env, run at the root of cocoindex directory ```bash maturin develop ``` From e741f6fe1724cd7e96574c0e131de0024d730d52 Mon Sep 17 00:00:00 2001 From: CocoIndex Dev Date: Thu, 27 Mar 2025 12:40:41 -0700 Subject: [PATCH 2/4] Update contributing.md --- docs/docs/about/contributing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/about/contributing.md b/docs/docs/about/contributing.md index 90acf9eb..968fb3d7 100644 --- a/docs/docs/about/contributing.md +++ b/docs/docs/about/contributing.md @@ -11,7 +11,7 @@ We love contributions from our community! This guide explains how to get involve - Install Rust toolchain: [docs](https://rust-lang.org/tools/install) -- (Optional) Setup and activate python virtual environment +- (Optional) Setup and activate python virtual environment. Make sure buildings / runnings all happen in the same virtual env ```bash virtualenv --python=$(which python3.12) .venv . .venv/bin/activate @@ -22,7 +22,7 @@ We love contributions from our community! This guide explains how to get involve pip install maturin ``` -- Build the library. In the same virtual env, run at the root of cocoindex directory +- Build the library. Run at the root of cocoindex directory. ```bash maturin develop ``` From 930436b39e617e0f1873bd09a1b1828179694821 Mon Sep 17 00:00:00 2001 From: CocoIndex Dev Date: Thu, 27 Mar 2025 12:50:54 -0700 Subject: [PATCH 3/4] Update contributing.md --- docs/docs/about/contributing.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/docs/about/contributing.md b/docs/docs/about/contributing.md index 968fb3d7..15fc32d4 100644 --- a/docs/docs/about/contributing.md +++ b/docs/docs/about/contributing.md @@ -11,18 +11,23 @@ We love contributions from our community! This guide explains how to get involve - Install Rust toolchain: [docs](https://rust-lang.org/tools/install) -- (Optional) Setup and activate python virtual environment. Make sure buildings / runnings all happen in the same virtual env +- (Optional) Setup Python virtual environment: ```bash virtualenv --python=$(which python3.12) .venv . .venv/bin/activate ``` + Activate the virtual environment, before any installings / buildings / runnings: -- Install maturin + ```bash + . .venv/bin/activate + ``` + +- Install maturin: ```bash pip install maturin ``` -- Build the library. Run at the root of cocoindex directory. +- Build the library. Run at the root of cocoindex directory: ```bash maturin develop ``` From 6426d3423f6852e8c1ae46a1537de5bf4adee044 Mon Sep 17 00:00:00 2001 From: CocoIndex Dev Date: Thu, 27 Mar 2025 12:51:08 -0700 Subject: [PATCH 4/4] Update contributing.md --- docs/docs/about/contributing.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/docs/about/contributing.md b/docs/docs/about/contributing.md index 15fc32d4..73925128 100644 --- a/docs/docs/about/contributing.md +++ b/docs/docs/about/contributing.md @@ -14,7 +14,6 @@ We love contributions from our community! This guide explains how to get involve - (Optional) Setup Python virtual environment: ```bash virtualenv --python=$(which python3.12) .venv - . .venv/bin/activate ``` Activate the virtual environment, before any installings / buildings / runnings: