rstmt-nrt 0.0.3

this crate focuses on providing support for the neo-riemannian theory of music
Documentation 
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

# rstmt

[![crates.io](https://img.shields.io/crates/v/rstmt?style=for-the-badge&logo=rust)](https://crates.io/crates/rstmt)
[![docs.rs](https://img.shields.io/docsrs/rstmt?style=for-the-badge&logo=docs.rs)](https://docs.rs/rstmt)
[![GitHub License](https://img.shields.io/github/license/FL03/rstmt?style=for-the-badge&logo=github)](https://github.com/FL03/rstmt/blob/main/LICENSE)

***

_**Warning: expect heavy changes to the API as the library is currently in the early stages of development and is not yet ready for production use.**

`rstmt` is a generalize music-theory toolkit written in Rust.

## Features

- [ ] American Standard Pitch Notation (ASPN)
- [ ] The Neo-Riemannian Theory

## Getting Started

### Prerequisites

Ensure you have the latest version of Rust installed. You can install Rust using [rustup](https://rustup.rs/).

```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

After installation, I always recommend ensuring that rustup is updated to the latest version:

```bash
rustup update
```

#### _Setting up for WebAssembly_

If you plan to compile this library for WebAssembly, ensure you have the appropriate targets installed. You can check your current targets with:

```bash
rustup target list --installed
```

If necessary, add the `wasm32-*` target(s) if you plan to compile for WebAssembly:

```bash
rustup target add wasm32-unknown-unknown wasm32-wasip1 wasm32-wasip2
```

### Building from the source

Start by cloning the repository

```bash
git clone https://github.com/FL03/rstmt.git -b main --depth 1
```

Then, navigate to the project directory:

```bash
cd rstmt
```

Once you're in the project directory, you can build the project using `cargo`:

```bash
cargo build -r --workspace --all-features
```

Or, if you want to run the tests, you can use:

```bash
cargo test -r --workspace --all-features
```

## Usage

Add this to your `Cargo.toml`:

```toml
[dependencies.rstmt]
features = [
    "nrt",
]
version = "0.0.x"
```

### Examples

#### _Example #1:_ Basic Usage

```rust
    extern crate rstmt;
    
    use rstmt::Note;
    use rstmt::nrt::Triad;

    fn main() -> Result<(), Box<dyn core::error::Error + Send + Sync + 'static>> {
        let root = Note::from_pitch(0);
        // initialize a c-major triad
        let triad = dbg!(Triad::major(root));
        // test the root of the triad
        assert_eq!(triad.root(), root);
        // test the parallel transformation
        assert_eq!(triad.parallel(), Triad::minor(root));
        // assert the invertibility of the transformations
        assert_eq!(triad.parallel().parallel(), triad);
        Ok(())
    }
```

## Contributing

Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.

Please make sure to update tests as appropriate.