Skip to content

Commit

Permalink
Update README for wasmer support.
Browse files Browse the repository at this point in the history
  • Loading branch information
twitchax committed Jun 17, 2023
1 parent 04c3464 commit 9de1c23
Showing 1 changed file with 22 additions and 8 deletions.
30 changes: 22 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,24 +19,24 @@ A music theory binary and library for Rust / JS (via WASM) ([capability playgrou
Windows:

```powershell
iwr https://github.com/twitchax/kord/releases/latest/download/kord_x86_64-pc-windows-gnu.zip
Expand-Archive kord_x86_64-pc-windows-gnu.zip -DestinationPath C:\Users\%USERNAME%\AppData\Local\Programs\kord
$ iwr https://github.com/twitchax/kord/releases/latest/download/kord_x86_64-pc-windows-gnu.zip
$ Expand-Archive kord_x86_64-pc-windows-gnu.zip -DestinationPath C:\Users\%USERNAME%\AppData\Local\Programs\kord
```

Mac OS (Apple Silicon):

```bash
curl -LO https://github.com/twitchax/kord/releases/latest/download/kord_aarch64-apple-darwin.zip
unzip kord_aarch64-apple-darwin.zip -d /usr/local/bin
chmod a+x /usr/local/bin/kord
$ curl -LO https://github.com/twitchax/kord/releases/latest/download/kord_aarch64-apple-darwin.zip
$ unzip kord_aarch64-apple-darwin.zip -d /usr/local/bin
$ chmod a+x /usr/local/bin/kord
```

Linux:

```bash
curl -LO https://github.com/twitchax/kord/releases/latest/download/kord_x86_64-unknown-linux-gnu.zip
unzip kord_x86_64-unknown-linux-gnu.zip -d /usr/local/bin
chmod a+x /usr/local/bin/kord
$ curl -LO https://github.com/twitchax/kord/releases/latest/download/kord_x86_64-unknown-linux-gnu.zip
$ unzip kord_x86_64-unknown-linux-gnu.zip -d /usr/local/bin
$ chmod a+x /usr/local/bin/kord
```

Cargo:
Expand All @@ -51,6 +51,20 @@ NPM:
$ npm install --save kordweb
```

### Wasmer

This has a reduced capability set (no audio input / output), but works well for some of the core use cases.

```bash
$ wasmer install twitchax/kord
```

Alternatively, you can use `wasmer run`.

```bash
$ wasmer run twitchax/kord -- describe Am7
```

### Help Docs

```bash
Expand Down

0 comments on commit 9de1c23

Please sign in to comment.