Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 1.11 KB

README.md

File metadata and controls

47 lines (30 loc) · 1.11 KB

🎼 music-theory codecov CircleCI

Create notes and get their frequencies! Create scales! Create chords!

Usage

Create new note using scientific notation

import { Note } from "music-theory";

let note = new Note("D#4");
note.freq; //Gives frequency

Create scales

import { Scale } from "music-theory";

let scale = new Scale("C3", "major"); //Generates one loop of the scale
scale.getNotes(); // Prints all the notes in the scale

let scale = new Scale("D4", "minor", 8); //Generates 8 notes in the minor scale

Develop

Clone this repository and run

The goal for this repository is to have 100% code coverage, so TDD is strongly encouraged!

yarn install

After dependencies have been installed, get started by running

yarn start

And don't forget to run the test watch too!

yarn jest