sing

CLI app to generate music and sing your text/file/code written in Rust.

Getting Started

Prerequisites

Make sure your have cargo available in your machine, see Rust official website for the installation guide if you don't have cargo yet.

Installing

cargo install sing

Usage

Generate music and sing with text:

sing -t "Hello World"

Generate music and sing based on a file:

sing -f <path-to-file>

Getting help:

sing -h

Built With

• clap - Command Line Argument Parser for Rust
• rodio - Audio playback library
• spinner - A simple library to add more interactivity to your terminal applications.

TODO

I'm still pretty new with Rust, here are a list of things I'm trying to work on:

• [ ] User can save the generated sound as wav or mp3
• [ ] More available sounds rather than simple sine wave
• [ ] Better logic to generate music, also probably use some pre defined scales.
• [ ] Multi track would be fun

Contributing

Free feel to open PR for any change/feature you would like to have, the project is still in a very early stage.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the MIT License - see the LICENSE.md file for details