diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..4c893ed --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +<h1 align="center">guitar</h1> + +<p align="center"> + <b>A toolkit for string-based instruments</b> +</p> + +`guitar` includes a number of tools for working with string-based instruments +with planned support for fret-less instruments. + +At the moment, the library is in a very early stage of development and is +subject to change; however, many of the core features such as `Note`, +`Fretboard`, `Pitch`, and a number of conversion functions are stable. + +## Usage + +### Installing from [crates.io](https://crates.io) + +To install from [crates.io](https://crates.io) you must have +[Rust](https://www.rust-lang.org/) installed. + +```toml +# Cargo.toml + +[dependencies] +guitar = "0.1.0" +``` + +## License + +This project is licensed with the [GNU General Public License v3.0](LICENSE). |