diff options
authorJustin Worthe <>2018-03-25 19:31:28 +0200
committerJustin Worthe <>2018-03-25 19:31:28 +0200
commit8a181806870ad767346f1aa0d70b481cbf527785 (patch)
parent0303e605b10af258e022257238f2f29afd2b35c3 (diff)
Updated project readme to include wasm build instructionsHEADmain
1 files changed, 26 insertions, 14 deletions
diff --git a/ b/
index 0e88d04..b97d6d1 100644
--- a/
+++ b/
@@ -11,6 +11,8 @@ trumpet and working on my intonation.
More information on how the project works can be read [[][here]].
+[[][Live demo]]
* Getting started
** Environment Setup
@@ -44,7 +46,6 @@ On Fedora
yum install gtk3-devel portaudio-devel
** Compiling and running
To compile the project:
@@ -66,6 +67,30 @@ setting up a CI server.
cargo test
+** WebAssembly
+This project also supports WebAssembly as a compilation target. To
+start, you need to install the nightly rust compiler toolchain and
+~wasm32-unknown-unknown~ target. If you installed Rust using Rustup,
+then you can do this with
+rustup toolchain install nightly
+rustup target add wasm32-unknown-unknown --toolchain nightly
+You can then compile the project with Make.
+make build-web
+If you choose not to use Make, you can look in ~Makefile~ for the
+instructions that ~make build-web~ is actually an alias for.
+After compiling, open ~target/site/index.html~ in any modern web
* Project structure
** File Structure
@@ -97,17 +122,4 @@ Unfortunately, Windows is not currently supported. If you wish to
contribute to adding Windows support, the most useful approach would
be to take a look at the [[][open issue in rust-portaudio]] for supporting
Windows in their build script.
-* Upcoming Features
-The main upcoming feature that I have planned is to create a
-WebAssembly build of the core logic of the application. With this,
-some HTML, and the Web Audio API, I will create an application that I
-can embed in my website to allow others to use without needing to
-compile or install it themselves.
-Progress can be seen by running ~make build-web~ and opening
-~target/site/index.html~. This requires Make to be installed, and the
-wasm32-unknown-unknown target to be installed in your Rust nightly
-toolchain. If you are using Rustup, this can be done by running
-~rustup target add --toolchain nightly wasm32-unknown-unknown~