Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/docs/about/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,22 @@ 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 Python virtual environment:
```bash
virtualenv --python=$(which python3.12) .venv
```
Activate the virtual environment, before any installings / buildings / runnings:

```bash
. .venv/bin/activate
```

- Install maturin
- Install maturin:
```bash
pip install maturin
```

- Build the library
- Build the library. Run at the root of cocoindex directory:
```bash
maturin develop
```
Expand Down