From 4850131ffcf4201fb75f4d3b9343a0d712fc3071 Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Thu, 6 Sep 2018 08:05:50 -0400 Subject: [PATCH] readme --- README.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 12d7adb..6b7deea 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ This (work in progress) library attempt to make exploring music theory approacha ![logo](https://github.com/kennethreitz/pytheory/raw/master/ext/pytheory-small.png) -## Usage Example +## True Scale -> Pitch Evaluation -``` {.pycon} +```pycon >>> from pytheory import TonedScale >>> c_minor = TonedScale(tonic='C4')['minor'] @@ -24,4 +24,27 @@ This (work in progress) library attempt to make exploring music theory approacha 14080/27 ``` + +## Chord Fingerings for Custom Tunings + +```pycon +>>> from pytheory import Tone, Fretboard, CHARTS + +>>> tones = ( +... Tone.from_string("F2"), +... Tone.from_string("C3"), +... Tone.from_string("G3"), +... Tone.from_string("D4"), +... Tone.from_string("A5"), +... Tone.from_string("E5") +... ) + +>>> fretboard = Fretboard(tones=tones) +>>> +>>> c_chord = CHARTS['western']["C"] + +>>> print(c_chord.fingering(fretboard=fretboard)) +(0, 0, 0, 3, 3, 3) +``` + ✨🍰✨