Skip to content

Commit d157288

Browse files
committed
Adjust README
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
1 parent e07383c commit d157288

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
## Goals of mlkem-c-aarch64
66

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

1212
There are tensions between these goals:

0 commit comments

Comments
 (0)