# Simplee > Musika

[![CI][ci-badge]][ci-url]
![GitHub top language][lang-badge]
[![License:MIT][license-badge]][license-url]
![GitHub code size in bytes][size-badge]
![GitHub last commit][last-commit-badge]
![GitHub watchers][watchers-badge]

## Description
A Rust crate for musical basic elements.

```rust
use musika_rs::{C, chords::{self}, scales::{self}};

let chord = C.maj();
println!("{chord:X}");

let scale = scales::major(C);
println!("{scale:X}");
```

## Build and Run
To build the crate
```bsh
cargo build
```

To build and view the internal documentstion:
```bsh
cargo doc --open
```

You can find more examples in the [examples][examples_folder] folder. To run an example:
```bsh
cargo run --example find
```

### Sharps and Flats
The crate allows you to print the notes either with sharps (#) or flats(b) by using X or x when fomating the chords or the scales:

```
let scale = minor(C);
assert_eq!(format!("{scale:X}"), "C minor [C, D, D#, F, G, G#, A#, C]");
assert_eq!(format!("{scale:x}"), "C minor [C, D, Eb, F, G, Ab, Bb, C]");
```


## Chords
The crate allows you to build the following chords:
- [major][major_chord_url]
- [major7][major7_chord_url]
- [minor][minor_chord_url]
- [minor7][minor7_chord_url]
- [minor7b5][minor7b5_chord_url]
- [diminished][dim_chord_url]
- [diminished7][dim7_chord_url]
- [dominant7][dom7_chord_url]

You can find all the chords in the [chords][chords_folder] folder.

## Scales
The crate allows you to build the following scales:
- [major][scale_major_file]
- [minor][scale_minor_file]

```rust
use musika_rs::scales::*;

let scale = scales::major(C);
assert_eq!(format!("{scale:X}"), "C major [C, D, E, F, G, A, B, C]");
assert_eq!(format!("{scale:x}"), "C major [C, D, E, F, G, A, B, C]");
```

You can find all the scales in the [scales][scales_folder] folder.

## Piano Exercises
You can find all piano exercises implemented in the exercises examples. You can see the practices by running:
```bsh
cargo run --example exercise1
cargo run --example exercise2
cargo run --example exercise3
cargo run --example exercise4
cargo run --example exercise5
```

- [Exercise 1][exercise1_file] | C - Am | F - G |
- [Exercise 2][exercise2_file] | C - G | Am - F | C - G | F - Em - Dm - C |
- [Exercise 3][exercise3_file] | Cx4 | Gx4 | Gx4 | Cx4 | Fx4 | Cx4 | Gx4 | Cx4 |
- [Exercise 4][exercise4_file] | C | F | Bdim | Em | Am | Dm | G | C |
- [Exercise 5][exercise5_file] | Dm9 Dm9 | G13 G13 | Dm9 Dm9 | G13 G13 |

## Resources
- [Piano Chords][piano_chords_url]
- [5 Jazz Chords that Actually Sound Great][5_jazz_chords_url]
- [The 12 major scales Formula & Pattern][12_major_scales_url]
- [The 12 minor scales Formula & Pattern][12_minor_scales_url]

## About
> Code designed and written on the beautiful island of [**Saaremaa**][estonia_url], Estonia.

[ci-badge]: https://github.com/veminovici/musika-rs/actions/workflows/ci.yml/badge.svg?branch=main
[ci-url]: https://github.com/veminovici/musika-rs/actions/workflows/ci.yml
[lang-badge]: https://img.shields.io/github/languages/top/veminovici/musika-rs
[license-badge]: https://img.shields.io/badge/License-MIT-yellow.svg
[license-url]: https://opensource.org/licenses/MIT
[size-badge]: https://img.shields.io/github/languages/code-size/veminovici/musika-rs
[last-commit-badge]: https://img.shields.io/github/last-commit/veminovici/musika-rs
[watchers-badge]: https://img.shields.io/github/watchers/veminovici/musika-rs
[piano_chords_url]: https://www.pianochord.org/
[estonia_url]: https://goo.gl/maps/DmB9ewY2R3sPGFnTA
[examples_folder]: ./examples/
[practices_file]: ./examples/practices.rs
[chords_folder]: ./src/chords/
[major_chord_url]: https://www.pianochord.org/c-major.html
[major7_chord_url]: https://www.pianochord.org/cmaj7.html
[minor_chord_url]: https://www.pianochord.org/cm.html
[minor7_chord_url]: https://www.pianochord.org/cm7.html
[minor7b5_chord_url]: https://www.pianochord.org/cm7b5.html
[dim_chord_url]: https://www.pianochord.org/c-dim.html
[dim7_chord_url]: https://www.pianochord.org/c-dim7.html
[dom7_chord_url]: https://www.pianochord.org/c7.html
[exercise1_file]: ./examples/exercise1.rs
[exercise2_file]: ./examples/exercise2.rs
[exercise3_file]: ./examples/exercise3.rs
[exercise4_file]: ./examples/exercise4.rs
[exercise5_file]: ./examples/exercise5.rs
[scale_minor_file]: ./src/scales/minor.rs
[scale_major_file]: ./src/scales/major.rs
[scales_folder]: ./src/scales/
[exercise5_file]: ./examples/exercise5.rs
[5_jazz_chords_url]: https://www.youtube.com/watch?v=WrLFCznbNMw
[12_minor_scales_url]: https://www.damvibes.com/music-theory/minor-scales/
[12_major_scales_url]: https://www.damvibes.com/music-theory/major-scales/