Skip to content

Commit 75d7490

Browse files
authored
Adding mewnala install instructions
1 parent 5a76da6 commit 75d7490

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,29 @@ libprocessing is an experimental native library with the goal of supporting the
44

55
## Getting started
66

7+
### mewnala (the python library)
8+
9+
Inside of our `processing_pyo3` crate we have created a python package that you can easily install with pip.
10+
Again, we are still very nascent, but let us know what kinds of snags you may run into while getting this set up.
11+
Try running the examples in the [processing_pyo3 examples directory](crates/processing_pyo3/examples).
12+
13+
```bash
14+
# have python3 installed on your system
15+
16+
# create a sketch folder and go inside
17+
mkdir my-sketch-folder && cd my-sketch-folder
18+
19+
# create a virtual env
20+
python -m venv .venv
21+
22+
# activate virtual env
23+
source .venv/bin/activate
24+
25+
pip install mewnala
26+
27+
python my_sketch.py
28+
```
29+
730
### Rust
831

932
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.
@@ -49,4 +72,4 @@ just wasm-serve
4972

5073
We want your help building this library! You can see a list of outstanding tasks in our [issues](https://github.com/processing/libprocessing). However, while we're still in the early phases, consider checking in with us first in the `#devs-chat` channel on [Discord](https://discord.gg/h99u95nU7q) to coordinate our efforts.
5174

52-
You can read our project design principles [here](./docs/principles.md).
75+
You can read our project design principles [here](./docs/principles.md).

0 commit comments

Comments
 (0)