MichaelSel / edoJS

A set of functions for manipulating musical pitches within a given EDO
GNU Affero General Public License v3.0
5 stars 0 forks source link

[README] Missing "statement of need" in README #3

Closed napulen closed 2 years ago

napulen commented 2 years ago

This issue is related to the following review: https://github.com/openjournals/joss-reviews/issues/3784

As per the JOSS guidelines, the README should have a "statement of need".

I assume the "statement of need" to be the current introductory paragraph in the README, which states: A JavaScript library for pitch set manipulation in any EDO tuning system.

I'd add the following information to this paragraph:

The summary in the paper already addresses most of these points. A simple solution would be to repeat the summary of the paper in the README.

At the very minimum, please unpack the acronym. Even as someone very familiar with Western music theory, I had to first search EDO to know what it meant.

MichaelSel commented 2 years ago

Thanks for your hard work. I Updated the README. Let me know if you think it's still lacking.

napulen commented 2 years ago

Looks good to me.