search

lexibank / uralex

UraLex basic vocabulary dataset
Creative Commons Attribution 4.0 International
3 stars 5 forks source link

Added citing information in the Readme #12

Closed MervideHeer closed 3 years ago

MervideHeer commented 3 years ago

I have discussed with our collaborators and we decided to add clear citing information to the readme for maximum visibility and citeability for our work. We can update the journal information as well after the papers are being published.

xrotwang commented 3 years ago

What about adding the info to the "real" README.md, i.e. the page rendered on the landing page of the dataset on github: https://github.com/lexibank/uralex/blob/release-2.0/README.md#how-to-cite ? I also think - for full transparency - people should cite the dataset as archived on Zenodo using the DOI and citation recommendation from Zenodo as well.

MervideHeer commented 3 years ago

What about adding the info to the "real" README.md, i.e. the page rendered on the landing page of the dataset on github: https://github.com/lexibank/uralex/blob/release-2.0/README.md#how-to-cite ? I also think - for full transparency - people should cite the dataset as archived on Zenodo using the DOI and citation recommendation from Zenodo as well.

Excellent points! Including both papers and the DOI will give the maximum coverage. I think it's also good to have the information all over the Readmes so that whenever people look at the files, they'll quickly see the citing information.

xrotwang commented 3 years ago

If you are happy with the README as is in my 2.0 PR, we could close this PR and merge the 2.0 one.

MervideHeer commented 3 years ago

If you are happy with the README as is in my 2.0 PR, we could close this PR and merge the 2.0 one.

I'm happy with the information in the link! I also added a sentence to the other Documentation Readme so all Readmes have the same information. Three citing "points": the two papers and the DOI

xrotwang commented 3 years ago

@MervideHeer But you'd still want the citation info in two places - the README and this file?

MervideHeer commented 3 years ago

@MervideHeer But you'd still want the citation info in two places - the README and this file?

Yes, I mean that whenever someone opens the page and sees the Readme (behind the link) or opens the documentation markdown, they could get the total citing information with the papers and DOI mention. That's why I added the new sentence into the markdown.

xrotwang commented 3 years ago

ok

xrotwang commented 3 years ago

See https://github.com/lexibank/uralex/pull/9/commits/40b365886effd22ba9c13042ee3a559181c97d1b