Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Write main README.md file #1

Open
tfaoliveira-sb opened this issue Jul 2, 2024 · 0 comments
Open

Write main README.md file #1

tfaoliveira-sb opened this issue Jul 2, 2024 · 0 comments
Assignees
@tfaoliveira-sb
Labels
documentation Improvements or additions to documentation

Comments

@tfaoliveira-sb
Copy link
Collaborator

The first version of the main README should have the following information (use as guideline; those are not rigid requirements):

  • intro section: quickly presenting the project and stating project goals (high-speed formally verified x25519 implementations, ...):

  • TLDR user section: quick overview on how to get example code running

  • implementations overview section: API; available implementations; current status (safety-checks? sct? stack-zeroing? proofs? CI integrated?); performance data (and comparison with alternatives in subsequent versions of the README.md)

  • developer section: quick overview and point the developer to README files from src/, test/, bench/, and proof.
@tfaoliveira-sb tfaoliveira-sb added the documentation Improvements or additions to documentation label Jul 2, 2024
@tfaoliveira-sb tfaoliveira-sb self-assigned this Jul 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tfaoliveira-sb tfaoliveira-sb

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tfaoliveira-sb