Skip to content

Commit

Permalink
Fix Windows package name.
Browse files Browse the repository at this point in the history
  • Loading branch information
twitchax committed Dec 20, 2022
1 parent a67c374 commit 7ef11c7
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 35 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ jobs:
args: --target x86_64-pc-windows-gnu --release
- uses: actions/upload-artifact@v3
with:
name: kord_x86_64-pc-windows-gnu.exe
name: kord_x86_64-pc-windows-gnu
path: target/x86_64-pc-windows-gnu/release/kord.exe
build_linux:
needs: test
Expand Down
5 changes: 0 additions & 5 deletions Cross.toml

This file was deleted.

58 changes: 29 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,38 +7,11 @@

# kord

A music theory library and binary for Rust.

## Library Usage

Add this to your `Cargo.toml`:

```toml
[dependencies]
kord = "0.1"
```

### Examples

```rust
use klib::known_chord::KnownChord;
use klib::modifier::Degree;
use klib::note::*;
use klib::chord::*;

// Check to see what _kind_ of chord this is.
assert_eq!(Chord::new(C).augmented().seven().known_chord(), KnownChord::AugmentedDominant(Degree::Seven));

// Parse a chord from a string, and inspect the scale.
assert_eq!(Chord::parse("Cm7b5").unwrap().scale(), vec![C, D, EFlat, F, GFlat, AFlat, BFlat]);

// From a note, create a chord, and look at the chord tones.
assert_eq!(C.into_chord().augmented().major7().chord(), vec![C, E, GSharp, B]);
```
A music theory binary and library for Rust.

## Binary Usage

### Install
### Install via Cargo

```bash
$ cargo install kord
Expand Down Expand Up @@ -85,6 +58,33 @@ B♭7(♯9)(♯11)
B♭, D, F, A♭, C♯, E
```

## Library Usage

Add this to your `Cargo.toml`:

```toml
[dependencies]
kord = "0.1"
```

### Examples

```rust
use klib::known_chord::KnownChord;
use klib::modifier::Degree;
use klib::note::*;
use klib::chord::*;

// Check to see what _kind_ of chord this is.
assert_eq!(Chord::new(C).augmented().seven().known_chord(), KnownChord::AugmentedDominant(Degree::Seven));

// Parse a chord from a string, and inspect the scale.
assert_eq!(Chord::parse("Cm7b5").unwrap().scale(), vec![C, D, EFlat, F, GFlat, AFlat, BFlat]);

// From a note, create a chord, and look at the chord tones.
assert_eq!(C.into_chord().augmented().major7().chord(), vec![C, E, GSharp, B]);
```

## Test

```bash
Expand Down

0 comments on commit 7ef11c7

Please sign in to comment.