Polish README

This commit is contained in:
Starbeamrainbowlabs 2021-07-25 01:05:32 +01:00
parent 7f4cc7e2d7
commit 42724a64ca
Signed by: sbrl
GPG key ID: 1BE5172E637709C2

View file

@ -2,6 +2,11 @@
> Converts MIDI files into music box scores that are ready to print. > Converts MIDI files into music box scores that are ready to print.
This is a command-line program that converts MIDI files to scores that can be printed for 30 note music boxes (such as [this one for example](https://smile.amazon.co.uk/dp/B0774TSP3T/)). While it does not currently support other music boxes (I don't have any others on hand), it could be extended to support them fairly trivially given the track width and the names of the notes it can play.
If you are unsure of how to create a MIDI file, I recommend [Musescore](https://musescore.org/), which is a free and open source music notation program that has a MIDI export function.
## System Requirements ## System Requirements
- Linux: - Linux:
@ -67,11 +72,16 @@ pdfposter -s1 score.pdf print.pdf
``` ```
## Useful Links ## Real-world usage
- [ffmpeg - showspectrumpic manual](https://ffmpeg.org/ffmpeg-filters.html#showspectrumpic) - (none yet - [get in touch](https://starbeamrainbowlabs.com/) if you've used this program somewhere cool!)
- [Frequency to Musical Note Converter](https://newt.phys.unsw.edu.au/music/note/)
## Useful Links
A collection of links that were useful in making this program.
- [ffmpeg - showspectrumpic manual](https://ffmpeg.org/ffmpeg-filters.html#showspectrumpic) -- useful for analysing the frequencies produces by a music box
- [Frequency to Musical Note Converter](https://newt.phys.unsw.edu.au/music/note/)
## Contributing ## Contributing
Contributions are very welcome - both bug reports and code contributions! Bug reports can be made to my email address (available on my website <https://starbeamrainbowlabs.com/>). Code contributions can be sent as a patch via email. Do this to generate a patch file you can attach to an email: Contributions are very welcome - both bug reports and code contributions! Bug reports can be made to my email address (available on my website <https://starbeamrainbowlabs.com/>). Code contributions can be sent as a patch via email. Do this to generate a patch file you can attach to an email: