The root README.md is the template from evaluation-function-boilerplate-python. It never mentions music, MIDI or audio, and is the first thing anyone sees.
Specific problems:
- The release-request badge still contains the literal placeholder
{REPO_NAME_HERE}, so the button links to a non-existent repository.
- The "Quickstart" chapter is the template setup guide, which the template itself says to delete after setup.
- The Repository Structure section omits
compare_MIDI.py and audio_processing.py, the two files that contain all the actual logic.
- The Development Workflow section refers to writing the function in
evaluation_function.wl, a Wolfram file that does not exist here.
- The documented
dev.py invocation is broken (see the boilerplate issue).
The real documentation already exists in docs/user.md and docs/dev.md and is good. The README should be a short description of what compareMusic does plus links to those two files.
Minor, related: docs/user.md and docs/dev.md duplicate the parameter table and input-format section verbatim. One should link to the other so they cannot drift.
The root
README.mdis the template fromevaluation-function-boilerplate-python. It never mentions music, MIDI or audio, and is the first thing anyone sees.Specific problems:
{REPO_NAME_HERE}, so the button links to a non-existent repository.compare_MIDI.pyandaudio_processing.py, the two files that contain all the actual logic.evaluation_function.wl, a Wolfram file that does not exist here.dev.pyinvocation is broken (see the boilerplate issue).The real documentation already exists in
docs/user.mdanddocs/dev.mdand is good. The README should be a short description of what compareMusic does plus links to those two files.Minor, related:
docs/user.mdanddocs/dev.mdduplicate the parameter table and input-format section verbatim. One should link to the other so they cannot drift.