Citation-Ready Audio Software Checklist

May 5, 2026 · View on GitHub

Use this checklist to make audio software easier to cite in academic, educational, and research contexts.

Minimum files

README.md with clear project purpose
LICENSE
CITATION.cff
CITATIONS.md or docs/CITATIONS.md
CHANGELOG.md
versioned GitHub Releases
reproducible build/run instructions

Recommended citation files

CITATION.cff fields

title
authors
version
date-released
url
repository-code
license
keywords
abstract/message

BibTeX fields

author
title
year
version
publisher
url
doi, once available

Research-readiness checklist

Include version number in the README.
Include reproducible examples.
Include validation/test reports.
Include known limitations.
Separate measured claims from roadmap claims.
Add Zenodo DOI after creating a release.
Link the DOI badge at the top of the README.

GareBear99 / TizWildin priority projects