Bruce 796aa120b1
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>
2025-10-02 10:14:24 -04:00
..