]> git.feebdaed.xyz Git - 0xmirror/liboqs.git/commit
More readable algorithm support in README.md (#2286)
authorBruce <g66xu@uwaterloo.ca>
Thu, 2 Oct 2025 14:14:24 +0000 (10:14 -0400)
committerGitHub <noreply@github.com>
Thu, 2 Oct 2025 14:14:24 +0000 (10:14 -0400)
commit796aa120b1ed4e41b2fe11a22084eb34ab77c348
tree2ec0a582ff0e6a72762fddb6ae2427179308f929
parente64026e27ae20aafee43a619c7c46cacff1936e7
More readable algorithm support in README.md (#2286)

* algorithm support table should replace the list of algorithms; minor refactor w.r.t. shebang, imports, and unnecessary global states

Signed-off-by: Ganyu (Bruce) Xu <g66xu@uwaterloo.ca>
* still need to fill in the content

Signed-off-by: Ganyu (Bruce) Xu <g66xu@uwaterloo.ca>
* first draft of alg support table

Signed-off-by: Ganyu (Bruce) Xu <g66xu@uwaterloo.ca>
* some refactoring

Signed-off-by: Ganyu (Bruce) Xu <g66xu@uwaterloo.ca>
* wrap standardization status with url to spec

Signed-off-by: Ganyu (Bruce) Xu <g66xu@uwaterloo.ca>
* Use split with no argument to split against any whitespace, not just space

Signed-off-by: Ganyu (Bruce) Xu <g66xu@uwaterloo.ca>
* documentation; make primary implementation monospaced

Signed-off-by: Ganyu (Bruce) Xu <g66xu@uwaterloo.ca>
* docs/algorithms/sig/sld_dsa.yml is generated from a Jinja template elsewhere

Signed-off-by: Ganyu (Bruce) Xu <g66xu@uwaterloo.ca>
* fixed invalid markdown anchors

Signed-off-by: Ganyu (Bruce) Xu <g66xu@uwaterloo.ca>
* algorithm family names will not link to docs/algorithms markdowns because Doxygen cannot handle them

Signed-off-by: Ganyu (Bruce) Xu <g66xu@uwaterloo.ca>
* add git diff to basic check for debugging purpose

Signed-off-by: Ganyu (Bruce) Xu <g66xu@uwaterloo.ca>
* resolved failure to consistently produce the same README.md

Signed-off-by: Ganyu (Bruce) Xu <g66xu@uwaterloo.ca>
* rephrasing standardization status for PQC third round candidates

Signed-off-by: Ganyu (Bruce) Xu <g66xu@uwaterloo.ca>
* improved explanation for NTRU's standardization status

Signed-off-by: Ganyu (Bruce) Xu <g66xu@uwaterloo.ca>
* another try at improving phrasing of standardization status

Signed-off-by: Ganyu (Bruce) Xu <g66xu@uwaterloo.ca>
* fixed typo

Signed-off-by: Ganyu (Bruce) Xu <g66xu@uwaterloo.ca>
* removed spec-url from lms.yml

Signed-off-by: Ganyu (Bruce) Xu <g66xu@uwaterloo.ca>
* revised specification URL to be consistent with spec-version

Signed-off-by: Ganyu (Bruce) Xu <g66xu@uwaterloo.ca>
* Revised FrodoKEM standardization status to reflect ISO consideration

Signed-off-by: Ganyu (Bruce) Xu <g66xu@uwaterloo.ca>
---------

Signed-off-by: Ganyu (Bruce) Xu <g66xu@uwaterloo.ca>
22 files changed:
README.md
docs/algorithms/kem/bike.yml
docs/algorithms/kem/classic_mceliece.yml
docs/algorithms/kem/frodokem.yml
docs/algorithms/kem/hqc.yml
docs/algorithms/kem/kyber.yml
docs/algorithms/kem/ml_kem.yml
docs/algorithms/kem/ntru.yml
docs/algorithms/kem/ntruprime.yml
docs/algorithms/sig/cross.yml
docs/algorithms/sig/falcon.yml
docs/algorithms/sig/mayo.yml
docs/algorithms/sig/ml_dsa.yml
docs/algorithms/sig/slh_dsa.yml
docs/algorithms/sig/snova.yml
docs/algorithms/sig/sphincs.yml
docs/algorithms/sig/uov.yml
docs/algorithms/sig_stfl/lms.yml
docs/algorithms/sig_stfl/xmss.yml
scripts/update_alg_support_table.py [new file with mode: 0755]
scripts/update_docs_from_yaml.py [changed mode: 0644->0755]
src/sig/slh_dsa/templates/slh_dsa_docs_yml_template.jinja