Skip to content

README: cite the pipeline by its Zenodo DOI - #13

Merged
Yehuda-Bergstein merged 2 commits into
mainfrom
docs/readme-doi
Oct 22, 2026
Merged

Yehuda-Bergstein merged 2 commits into
mainfrom
docs/readme-doi

Conversation

@Yehuda-Bergstein

@Yehuda-Bergstein Yehuda-Bergstein commented Oct 22, 2026 •

Copy link
Copy Markdown
Member

Replaces the README's Citation section. The old BibTeX entry had no authors and no DOI, and its title matched neither CITATION.cff nor the Zenodo record.

The section now gives:

  • the all-versions Zenodo DOI, 10.5281/zenodo.23562102, which resolves to the latest release;
  • the v0.2.2 release DOI, 10.5281/zenodo.23562103;
  • an APA line with the title and the five creators of the Zenodo record;
  • a pointer to GitHub's "Cite this repository", which reads CITATION.cff.

Both DOIs resolve through doi.org to Zenodo (checked 22 Oct 2026). The README has no badges, so no DOI badge was added. In the README only the Citation section changes.

CITATION.cff gets one line, doi: "10.5281/zenodo.23562102", so GitHub's "Cite this repository" export carries the same all-versions DOI. cffconvert 2.0.0 validates the file against CFF schema 1.2.0.

The Citation section held a BibTeX entry with no authors and no DOI, and its title, "ResXR: XR Experiment Data Processing Pipeline", matched neither CITATION.cff nor the Zenodo record. The section now gives the all-versions DOI 10.5281/zenodo.23562102, which resolves to the latest release, the v0.2.2 DOI 10.5281/zenodo.23562103, an APA line with the title and the five creators of the Zenodo record, and a pointer to GitHub's "Cite this repository", which reads CITATION.cff. Both DOIs resolve through doi.org to Zenodo (checked 22 Oct 2026). The README has no badges, so it gets no DOI badge.
The file had no doi field, so GitHub's "Cite this repository" export carried no DOI. It now gives the concept DOI 10.5281/zenodo.23562102, which resolves to the latest release, the same DOI the README's Citation section names. cffconvert 2.0.0 validates the file against CFF schema 1.2.0.
@Yehuda-Bergstein
Yehuda-Bergstein merged commit 87ef589 into main Oct 22, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant