Skip to content

Commit

Permalink
Merge pull request #21 from anvlkv/main
Browse files Browse the repository at this point in the history
mention build deps #17
  • Loading branch information
alisomay authored Apr 21, 2024
2 parents 86e58d1 + cb9be6a commit b7b4baf
Showing 1 changed file with 40 additions and 2 deletions.
42 changes: 40 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,45 @@ Though pd is designed as a desktop application, [libpd](https://github.com/libpd

It is thoroughly [documented](https://docs.rs/libpd-rs/latest/libpd_rs/#), well [tested](/tests/) and enriched with various [examples](/examples/) to get you started right away.

Now let's make some sound! 🔔
## Now let's make some sound! 🔔

---
### Build dependencies

To be able to buid `libpd` install `cmake` and `llvm` if you don't have them already.
See [building libpd](https://github.com/libpd/libpd/blob/master/README.md#building-libpd) for more details and options.

#### Linux

```
sudo apt install cmake
```
Follow the llvm [installation instructions](https://apt.llvm.org/#llvmsh)


#### windows

With chocolately

```
choco install cmake
choco install llvm
```

With winget

```
winget install -e --id Kitware.CMake
winget install -e --id LLVM.LLVM
```

#### macOS

```
brew install cmake
brew install llvm
```

### Cargo dependencies

Add the following dependencies to your `Cargo.toml`:

Expand All @@ -29,6 +65,8 @@ libpd-rs = "0.1"
cpal = "0.15"
```

### Example code

Paste the code into your `main.rs`:

⚠️ **Warning** ⚠️: This example will produce audio, so please keep your volume at a reasonable level for safety.
Expand Down

0 comments on commit b7b4baf

Please sign in to comment.