Update README.md - Githubissues

HoerTech-gGmbH / openMHA

The open Master Hearing Aid (openMHA)

http://www.openmha.org

GNU Affero General Public License v3.0

252 stars 74 forks source link

Update README.md #56

Closed digitalfrost closed 1 year ago

digitalfrost commented 2 years ago

Add DOI as text for easy copy and paste of the DOI
Move DOI badge to top of page
Add license badge

tobiasherzke commented 2 years ago

I agree that since we have a section "How to cite" in the main Readme, the DOI for the software should be part of that section.

Also, adding a license badge to the README does not hurt.

We will however need to investigate how these additions will affect the release script and the release procedure instructions and adapt them if necessary.

tobiasherzke commented 2 years ago

As the release-specific DOI can only be created after creating the release commit (which includes the updated README.md), I see no possibility to include the release-specific DOI in the text of file README.md. We will have to use the all-versions DOI everywhere, as we did before. With this modification, I will propose this change to our internal review process.

tobiasherzke commented 1 year ago

Similar change applied in a26d3ed.