Skip to content

Commit c25868d

Browse files
committed
Add bindings documentation
1 parent 26ebfc2 commit c25868d

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

bindings/python/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Python bindings for Pink
2+
3+
## Requirements
4+
5+
- Maturin
6+
7+
## Usage
8+
9+
### With Maturin (recommended)
10+
11+
```bash
12+
uv venv
13+
source .venv/bin/activate
14+
maturin develop
15+
```
16+
17+
### Without Maturin
18+
19+
It's much slower to compile without maturin, but it can be used as a normal package.
20+
21+
```bash
22+
uv venv
23+
source .venv/bin/activate
24+
uv sync
25+
```

0 commit comments

Comments
 (0)