Skip to content

Commit 8ccb0c7

Browse files
authored
Update README.md to use uv as method to install mewnala (#110)
merging but this needs to improved. i am merging this incremental improvement
1 parent 3046320 commit 8ccb0c7

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

README.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,31 @@ Inside of our `processing_pyo3` crate we have created a python package that you
1010
Again, we are still very nascent, but let us know what kinds of snags you may run into while getting this set up.
1111
Try running the examples in the [processing_pyo3 examples directory](crates/processing_pyo3/examples).
1212

13-
```bash
14-
# have python3 installed on your system
13+
We are big fans of [uv](https://github.com/astral-sh/uv) and this is the easiest way to get started using `mewnala`
1514

16-
# create a sketch folder and go inside
17-
mkdir my-sketch-folder && cd my-sketch-folder
15+
#### Setting up uv on linux or macOS
16+
```bash
17+
curl -LsSf https://astral.sh/uv/install.sh | sh
18+
```
1819

19-
# create a virtual env
20-
python -m venv .venv
20+
#### For Windows users:
21+
```bash
22+
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
23+
```
2124

22-
# activate virtual env
23-
source .venv/bin/activate
25+
#### Install a mewnala
26+
```bash
27+
# Initialize a project with uv
28+
uv init mewnala-sketchbook && cd mewnala-sketchbook
2429

25-
pip install mewnala
30+
# add the package
31+
uv add mewnala
2632

27-
python my_sketch.py
33+
# run a sketch
34+
uv run sketch.py
2835
```
2936

30-
### Rust
37+
### Rust (libprocessing)
3138

3239
You'll need to install the Rust toolchain to work on this project. Most users will want to install Rust via [`rustup`](https://rustup.rs/), which helps manage Rust toolchain versions.
3340

0 commit comments

Comments
 (0)