Skip to content

Commit

Permalink
Update README.mds
Browse files Browse the repository at this point in the history
  • Loading branch information
Woyten committed Jul 10, 2020
1 parent 199a0f3 commit d191445
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 17 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
Explore musical tunings and create synthesizer tuning files for microtonal scales.

# Resources

- [Changelog](https://github.com/Woyten/tune/releases)
- [CLI documentation](https://crates.io/crates/tune-cli)
- [API documentatin](https://docs.rs/tune/)

# Overview

`tune` is planned to be part of a larger ecosystem for microtonal software in Rust.
Expand All @@ -16,11 +22,3 @@ So far, `tune` offers a CLI and an API with the following features:
- Export scales
- To Scala (scl and kbm) format
- As Midi Tuning Standard (MTS) Sysex Messages

## CLI Documentation

https://crates.io/crates/tune-cli

## API Documentation

https://docs.rs/tune/
34 changes: 25 additions & 9 deletions microwave/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
Make xenharmonic music and explore musical tunings.

# Resources

- [Changelog](https://github.com/Woyten/tune/releases)
- [Scale expressions](https://crates.io/crates/tune-cli)

# Overview

`microwave` is a microtonal waveform synthesizer based on:
Expand All @@ -8,7 +13,7 @@ Make xenharmonic music and explore musical tunings.
- [Nannou](https://nannou.cc/) – a UI framework
- [FluidLite](https://crates.io/crates/fluidlite) – a soundfont renderer

It features a virtual piano UI enabling you to play polyphonic microtonal melodies with your touch screen, keyboard or mouse. The UI provides information about pitches and just intervals in custom tuning systems.
It features a virtual piano UI enabling you to play polyphonic microtonal melodies with your touch screen, computer keyboard, MIDI keyboard or mouse. The UI provides information about pitches and just intervals in custom tuning systems.

# Installation

Expand All @@ -33,22 +38,33 @@ microwave # Continuous
microwave equal 1:22:2 # 22-EDO scale
```

For playback of sampled sounds provide the location of a soundfont file:
This should spawn a window displaying a virtual keyboard. Use your touch screen, computer keyboard or mouse to play melodies on the virtual piano.

![](https://github.com/Woyten/tune/raw/master/microwave/screenshot.png)


## Soundfont Files

For playback of sampled sounds you need to provide the location of a soundfont file:

```bash
microwave --sf /usr/share/sounds/sf2/default-GM.sf2 equal 1:22:2
```

If you want to load compressed sf3 files you need to enable the `sf3` feature. Note that the startup will be a lot slower since the sondfont file needs to be decompressed first.
If you like to use compressed sf3 files you need to compile `microwave` with the `sf3` feature enabled. Note that the startup will take significantly longer since the soundfont needs to be decompressed first.

After everything has been loaded you should see a window showing a virtual keyboard.
## MIDI Input

![](https://github.com/Woyten/tune/raw/master/microwave/screenshot.png)

Use your touch screen, keyboard or mouse to play melodies on the virtual piano.

To see how scale expressions work, visit [tune](https://crates.io/crates/tune-cli).
To use a MIDI device as an input source, use the `--ms` option:

```bash
microwave --ms 1 equal 1:22:2
```

## More Options

For a complete list of command line options run

```bash
microwave help
```
5 changes: 5 additions & 0 deletions tune-cli/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
Explore musical tunings and create synthesizer tuning files for microtonal scales.

# Resources

- [Changelog](https://github.com/Woyten/tune/releases)


# Overview

`tune-cli` is the command line tool for the microtonal [tune](https://crates.io/crates/tune) library.
Expand Down

0 comments on commit d191445

Please sign in to comment.