aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: c1f39774df04e622a76ed2f85ed8a74d53928a4a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
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 = "*" # or a specific version
```

## License

This project is licensed with the [GNU General Public License v3.0](LICENSE).