Edirom / Edirom-Online

Edirom Online is a tool for presenting historical-critical music editions in digital form.
GNU General Public License v3.0
21 stars 25 forks source link

[ftr] add mission statement to Readme #399

Closed peterstadler closed 3 months ago

peterstadler commented 4 months ago

This is not a technical issue, but rather to improve the documentation.

When you hit the "landing page" of the Edirom Online repo at Github, the Readme is automatically displayed (by GitHub). So, this is the very first information that users will get and thus should contain more details and context regarding the project. Here are some proposals:

… there might be more

krHERO commented 4 months ago

hi @peterstadler thanks for opening this issue. in the edirom online reloaded project we are also working on the improvement of "building communities". regarding this topic i started with creating templates for issues with PR395. one of the next steps is updating the contributing.md (for some discussion see #227) and also updating the readme.md is on the agenda (started already to search and review readme templates). so we already have an issue here to reference our commits to.

we could use this isse to collect content we want to have in the readme.md starting with your suggestions