Skip to content

Commit

Permalink
Adjust README
Browse files Browse the repository at this point in the history
The README previously suggested that 'clean' code is a necessity for
amenability to verification. This was not intentional, and as noted
in #63, not true.

This commit removes the mentioning of 'clean' code from the README.
The primary qualities that we seek from 'cleanliness' are amenability
for manual audit and adaptability. The former was already mentioned
explicitly in the README, while the latter is added in this commit.

Closes #63
  • Loading branch information
hanno-becker committed Jun 21, 2024
1 parent e07383c commit d157288
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
## Goals of mlkem-c-aarch64

The primary goals of this project are as follows:
- _Assurance:_ Clean code that's extensively tested and amenable for audit and verification
- _Ease of use:_ Permissive licensing, modularity, few dependencies
- _Assurance:_ Offer code that's extensively tested and amenable for audit and verification
- _Ease of use:_ Permissive licensing, modularity, adaptability, few dependencies
- _Performance:_ Competitive performance for most Armv8-A/Armv9-A platforms

There are tensions between these goals:
Expand Down

0 comments on commit d157288

Please sign in to comment.