Prepare next microwave version

Woyten · May 24, 2020 · 41876e5 · 41876e5
1 parent 0fc9af3
commit 41876e5
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 4 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/microwave/Cargo.toml b/microwave/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "microwave"
-version = "0.2.0"
+version = "0.3.0"
 authors = ["Woyten <[email protected]>"]
 description = "Make xenharmonic music and explore musical tunings."
 repository = "https://github.com/Woyten/tune/tree/master/microwave"

diff --git a/microwave/README.md b/microwave/README.md
@@ -2,7 +2,11 @@ Make xenharmonic music and explore musical tunings.
 
 # Overview
 
-`microwave` is a microtonal waveform synthesizer based on the microtonal [tune](https://crates.io/crates/tune) library and the [Nannou](https://nannou.cc/) UI framework.
+`microwave` is a microtonal waveform synthesizer based on:
+
+- [tune](https://crates.io/crates/tune) &ndash; a microtonal library
+- [Nannou](https://nannou.cc/) &ndash; a UI framework
+- [FluidLite](https://crates.io/crates/fluidlite) &ndash; a soundfont renderer
 
 It features a virtual piano UI enabling you to play polyphonic microtonal melodies with your touch screen or mouse. The UI provides information about pitches and just intervals in custom tuning systems.
 
@@ -22,13 +26,19 @@ If this doesn't help or you don't use `apt`, try following these [instructions](
 
 # Usage
 
-You can run `microwave` in continous or scale-based mode:
+You can run `microwave` in continuous or scale-based mode:
 
 ```bash
 microwave              # Continuous
 microwave equal 1:22:2 # 22-EDO scale
 ```
 
+For playback of sampled sounds provide the location of a soundfont file:
+
+```bash
+microwave -s /usr/share/sounds/sf2/FluidR3_GM.sf2 equal 1:22:2
+```
+
 The command should spawn a a window showing a virtual keyboard.
 
 ![](https://github.com/Woyten/tune/raw/master/microwave/screenshot.png)

diff --git a/microwave/screenshot.png b/microwave/screenshot.png