search

airr-community / airr-standards

AIRR Community Data Standards
https://docs.airr-community.org
Creative Commons Attribution 4.0 International
35 stars 23 forks source link

Update README and associated files #613

Closed bussec closed 2 years ago

bussec commented 2 years ago

Fixes #430

Updating of README.rst and related files.

bussec commented 2 years ago

@javh @schristley Please have a look, thanks!

schristley commented 2 years ago

Looks good! Some of the references have extra apostrophes and underscores, while others don't, now sure why. Probably don't need a separate file for contributors, if the copyright/license is in the readme, could just list the contributors right after it.

bussec commented 2 years ago

@schristley

Some of the references have extra apostrophes and underscores, while others don't, now sure why.

These were unresolved reference, as some of them contained additional spaces. This is resolved now.

Probably don't need a separate file for contributors, if the copyright/license is in the readme, could just list the contributors right after it.

My idea was to have the contributor list in a format that would be easier to parse so that we can ultimately generated the .zenodo.json automatically. But that's just an idea, I am open to put it back into the README, if we don't want to have another file in the main directory.