tunes

(โ˜… 154)

A Rust library for music composition, synthesis, and audio generation. Build complex musical pieces with an intuitive, expressive API.

  • .gitignore
  • Cargo.toml
  • CHANGELOG.md
  • LICENSE-APACHE
  • LICENSE-MIT
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/sqrew/tunes

Downloads the entire project code from GitHub to your computer.

cd tunes

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • APT (Debian/Ubuntu ๊ณ„์—ด) Built into Debian/Ubuntu-based Linux distributions.
  • Rust (rustup) Rust is required to use cargo.
sudo apt install libasound2-dev

Installs directly from the APT package repository (Debian/Ubuntu-based).

cargo install wasm-pack

Builds and installs the package published on crates.io โ€” no need to clone the repo yourself.

cargo install mdbook

Builds and installs the package published on crates.io โ€” no need to clone the repo yourself.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo install wasm-pack

Builds and installs the package published on crates.io โ€” no need to clone the repo yourself.

cargo run --bin tunes-live -- my_live.rs

Builds and then immediately runs the program.

cargo test

Type this command into your terminal and run it.

cargo run --release --example sample_playback_demo

Builds and then immediately runs the program.

cargo run --release --example wav_export_demo

Builds and then immediately runs the program.

โœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation