Update README with docs

This commit is contained in:
Jonathan Harker 2024-10-15 14:55:15 +13:00
parent a85898b416
commit 8bb811cf1c
3 changed files with 9 additions and 7 deletions

View file

@ -25,17 +25,20 @@ In Python:
from setclass import SetClass
sc = SetClass(0, 3, 5, 6, 7, 10, 11) # Forte 7-20; pitch classes as integers 0-11
sc.versions
sc.brightest_form
sc.darkest_form
sc.rahn_normal_form
sc.forte_name
sc.duodecimal_notation # SetClass[0,3,5,6,7,T,E]
```
Proper library documentation to come soon with Sphinx.
Documentation is generated from the doc comments with Sphinx, and in the meantime is available [here](https://git.jon.geek.nz/docs/public/setclass/setclass.html):
```
make -C docs html
```
## TODO
- Documentation (Sphinx)
- <s>Documentation (Sphinx)</s>
- Interoperate with music21 objects
- Generate MIDI files
- Generate LilyPond files for set pitches