Add Zenodo badge to README

ProjectPythia / pythia-foundations

Jupyterbook source for the Foundations collection

http://foundations.projectpythia.org

Apache License 2.0

59 stars 42 forks source link

Closed jukent closed 1 year ago

jukent commented 1 year ago

Adds link to the Zenodo page for the foundations book release.

Points to consider: badge link needs to be updated with new releases, still need to add prominent how to cite section.

Related to #309 and #344

github-actions[bot] commented 1 year ago

👋 Thanks for opening this PR! The Cookbook will be automatically built with GitHub Actions. To see the status of your deployment, click below. 🔍 Git commit SHA: 3727dc6f88d0151115c464c3ad3e34e9af3e1e3c ✅ Deployment Preview URL: https://ProjectPythia.github.io/pythia-foundations/_preview/389

brian-rose commented 1 year ago

@jukent nice work so far!

It looks like Zenodo has already created a persistent "latest version" DOI for this repo: https://doi.org/10.5281/zenodo.7884571 which will always resolve to the most recent release: https://help.zenodo.org/#versioning

Does it make more sense to use that link rather than the version-specific link in the badge?

It might help to look around at other projects and see how they handle the versioning.

jukent commented 1 year ago

Yes I think that's right, it links to the latest DOI. I just wasn't sure yet when i made the PR.