search

Colfenor / classic-mceliece-rust

This is a pure-rust safe-rust implementation of the Classic McEliece post-quantum scheme
MIT License
24 stars 11 forks source link

Improve readme examples, split them up #23

Closed faern closed 2 years ago

faern commented 2 years ago

The documentation examples did not run on Windows. And it was messy! It was a single huge example trying to show all ways of using the crate. I think this is way more structured!

faern commented 2 years ago

Ok. All variants from mceliece460896 and up simply don't run on the stack on Windows. I'm not sure how this worked before my last PR. Were those tests not run for some reason, or did #20 make the stack usage worse?

Either way, this PR at least makes the documentation way nicer to read.

EDIT: No, the large variants don't run on the stack on Windows in commit f074762 either. So not a regression introduced by #20. Looks like the code examples in the readme did not actually run in the CI before then, so that's why the CI worked.