Skip to content
Open
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
29 changes: 18 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,31 @@ Inside of our `processing_pyo3` crate we have created a python package that you
Again, we are still very nascent, but let us know what kinds of snags you may run into while getting this set up.
Try running the examples in the [processing_pyo3 examples directory](crates/processing_pyo3/examples).

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

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

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

# activate virtual env
source .venv/bin/activate
#### Install a mewnala
```bash
# Initialize a project with uv
uv init mewnala-sketchbook && cd mewnala-sketchbook

pip install mewnala
# add the package
uv add mewnala

python my_sketch.py
# run a sketch
uv run sketch.py
```

### Rust
### Rust (libprocessing)

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.

Expand Down
Loading