Skip to content

docs: add Zenodo DOI badge and CITATION.cff doi #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sparkainlp-x merged 1 commit into from
Sep 27, 2026
Merged

docs: add Zenodo DOI badge and CITATION.cff doi #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@ authors:
repository-code: "https://github.com/sparkainlp-x/qldpc_decoder_cpp"
url: "https://sparkainlpx.xyz"
license: MIT
doi: "10.5281/zenodo.22985527"
identifiers:
- type: doi
value: "10.5281/zenodo.22985527"
description: "Concept DOI (all versions, Zenodo)"
- type: doi
value: "10.5281/zenodo.22985528"
description: "Version DOI for v0.1.1 (Zenodo)"
version: "0.1.1"
date-released: "2026-09-26"
abstract: >-
Expand Down
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ C++/HLS **research scaffold** for a qLDPC decoder: CMake + Catch2 + a sparse GF(
[![C++ CI](https://github.com/sparkainlp-x/qldpc_decoder_cpp/actions/workflows/ci.yml/badge.svg)](https://github.com/sparkainlp-x/qldpc_decoder_cpp/actions/workflows/ci.yml)
[![Status: research prototype](https://img.shields.io/badge/status-research%20prototype-orange.svg)](#what-it-is-not)
[![Hardware results: UNRUN](https://img.shields.io/badge/hardware%20results-UNRUN-lightgrey.svg)](#evidence-tags)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.22985527.svg)](https://doi.org/10.5281/zenodo.22985527)

*English first; the original French documentation follows below. / La documentation originale en français suit.*

Expand Down Expand Up @@ -76,6 +77,8 @@ ADR-001 governs the OES-32 residual family (normative: [oes32-residual@b77b612](

## Citation

Archived on Zenodo: concept DOI [10.5281/zenodo.22985527](https://doi.org/10.5281/zenodo.22985527) (all versions; resolves to the latest). The v0.1.1 archive is [10.5281/zenodo.22985528](https://doi.org/10.5281/zenodo.22985528).

Citation metadata is in [CITATION.cff](CITATION.cff); GitHub shows a "Cite this repository" button. Please also cite the upstream [`ldpc`](https://github.com/quantumgizmos/ldpc) library by Joschka Roffe.

## License
Expand Down
Loading