Skip to content

Commit 19da5c0

Browse files
Update contributing.md with instructions to build cocoindex (#222)
1 parent f9aac6a commit 19da5c0

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

docs/docs/about/contributing.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,22 @@ We love contributions from our community! This guide explains how to get involve
1111

1212
- Install Rust toolchain: [docs](https://rust-lang.org/tools/install)
1313

14-
- (Optional) Setup and activate python virtual environment
14+
- (Optional) Setup Python virtual environment:
1515
```bash
1616
virtualenv --python=$(which python3.12) .venv
17+
```
18+
Activate the virtual environment, before any installings / buildings / runnings:
19+
20+
```bash
1721
. .venv/bin/activate
1822
```
1923

20-
- Install maturin
24+
- Install maturin:
2125
```bash
2226
pip install maturin
2327
```
2428

25-
- Build the library
29+
- Build the library. Run at the root of cocoindex directory:
2630
```bash
2731
maturin develop
2832
```

0 commit comments

Comments
 (0)