Skip to content

docs: English-first README skeleton + CITATION.cff - #6

Merged
sparkainlp-x merged 1 commit into
mainfrom
docs/readme-citation
Sep 26, 2026
Merged

sparkainlp-x merged 1 commit into
mainfrom
docs/readme-citation

Conversation

@sparkainlp-x

Copy link
Copy Markdown
Owner
  • README: English-first account-wide skeleton (badges incl. license + CI + research-prototype + hardware UNRUN, What it is / is NOT, Quickstart, Tests, Evidence tags, Relationship to ADR-001, Citation, License). The original French documentation is kept in full below it (headings nested under Description en français). Evidence table and known limitations unchanged in substance.
  • CITATION.cff (v0.1.0, MIT, ORCID left as a commented placeholder; references the upstream ldpc library). Validated with cffconvert.

Quickstart verified in a fresh clone (Debian, g++ 14.2, CMake 3.31, default generator): build OK, smoke binary prints the expected two lines, ctest 100% passed, benchmark PASS under the 1 µs gate. I deliberately did not add the local benchmark number to the README, to avoid publishing a new metric. No code or workflow changes. PR #2 stays open (awaiting author data).

@sparkainlp-x
sparkainlp-x merged commit d0f2122 into main Sep 26, 2026
2 checks passed
@sparkainlp-x
sparkainlp-x deleted the docs/readme-citation branch September 26, 2026 15:19
sparkainlp-x added a commit that referenced this pull request Sep 27, 2026
English-first README skeleton (French documentation kept), CITATION.cff (v0.1.0) referencing upstream ldpc. Hardware results remain UNRUN.
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