Skip to content

Commit 1ee8950

Browse files
authored
make easier to follow
1 parent 913ddb9 commit 1ee8950

1 file changed

Lines changed: 39 additions & 40 deletions

File tree

README.md

Lines changed: 39 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -2,95 +2,94 @@
22

33
libprocessing is an experimental native library with the goal of supporting the implementation of the core Processing API in a variety of languages. The library is written in the [Rust programming language](https://rust-lang.org/) and built on top of the [Bevy game engine](https://bevy.org/). libprocessing uses [WebGPU](https://webgpu.org/) as its rendering backend and is designed to (eventually) support desktop, mobile, and web targets.
44

5-
## Getting started
5+
## Getting Started
66

7-
### mewnala (the python library)
87

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).
8+
We are big fans of [uv](https://github.com/astral-sh/uv) and this is the easiest way to get started using `mewnala`.
129

13-
We are big fans of [uv](https://github.com/astral-sh/uv) and this is the easiest way to get started using `mewnala`
10+
### installing uv
11+
12+
**Setting up uv on Linux or Mac:**
1413

15-
#### Setting up uv on Linux or Mac:
1614
```bash
1715
curl -LsSf https://astral.sh/uv/install.sh | sh
1816
```
1917

20-
#### For Windows users:
18+
**Setting up uv on Windows:**
19+
2120
```bash
2221
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
2322
```
2423

25-
#### Install a mewnala
26-
```bash
27-
# Initialize a project with uv
28-
uv init mewnala-sketchbook && cd mewnala-sketchbook
24+
You'll need to install the Rust toolchain to work on this project. Most people will want to install Rust via [`rustup`](https://rustup.rs/), which helps manage Rust toolchain versions:
2925

30-
# add the package
31-
uv add mewnala
26+
### Installing rustup
3227

33-
# run a sketch
34-
uv run sketch.py
28+
**Setting up rustup on Linux or Mac:**
29+
30+
```bash
31+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
3532
```
3633

37-
### Rust (libprocessing)
34+
**Setting up rustup on Windows:**
3835

39-
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:
36+
Download and run [these binaries](https://rustup.rs/#) for [Windows 64-bit](https://win.rustup.rs/x86_64) or [Windows on ARM](https://win.rustup.rs/aarch64).
4037

41-
**For Linux and Mac users:**
38+
### Add the wasm32 target for rustuo
4239

43-
```bash
44-
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
40+
You'll need the wasm32 target:
41+
42+
```bash
43+
rustup target add wasm32-unknown-unknown
4544
```
4645

47-
### Build commands
46+
### installing `just`
4847

49-
This project uses [just](https://github.com/casey/just) as a command runner. Run `just` to see available commands.
48+
This project uses [just](https://github.com/casey/just) as a command runner.
5049

5150
Before building, you'll need to install just:
5251
```bash
5352
cargo install just
5453
```
54+
Run `just` to see available commands.
5555

56-
## Building libprocessing for web
57-
58-
The `processing_wasm` crate provides WebAssembly bindings that expose a JavaScript API mirroring the C FFI.
5956

60-
### Requirements
57+
### Install `wasm-pack`
6158

6259
Install [wasm-pack](https://rustwasm.github.io/wasm-pack/):
6360

6461
```bash
6562
cargo install wasm-pack
6663
```
64+
The `processing_wasm` crate provides WebAssembly bindings that expose a JavaScript API mirroring the C FFI.
6765

68-
You'll also need the wasm32 target:
6966

70-
```bash
71-
rustup target add wasm32-unknown-unknown
72-
```
67+
## Examples
7368

7469

70+
**libprocessing example**
7571

76-
### Build
72+
73+
This outputs the package to `target/wasm/`.
7774

7875
```bash
7976
just wasm-build
8077
```
81-
82-
This outputs the package to `target/wasm/`.
83-
84-
### Run the example
78+
This shows the example in your browser.
8579

8680
```bash
8781
just wasm-serve
8882
```
8983

84+
**Install a mewnala**
9085

86+
```bash
87+
# Initialize a project with uv
88+
uv init mewnala-sketchbook && cd mewnala-sketchbook
9189

92-
## Contributing
93-
94-
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.
90+
# Add the package
91+
uv add mewnala
9592

96-
You can read our project design principles [here](./docs/principles.md).
93+
# Run a sketch
94+
uv run sketch.py
95+
```

0 commit comments

Comments
 (0)