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.

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

Add more documentation to the main README and development infos #44

Merged
merged 4 commits into from
Aug 31, 2022

Conversation

sirkrypt0
Copy link
Contributor

No description provided.

@sirkrypt0 sirkrypt0 self-assigned this Aug 31, 2022
DEVELOPMENT.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@sirkrypt0 sirkrypt0 requested a review from frcroth August 31, 2022 13:50
@sirkrypt0 sirkrypt0 force-pushed the feature/more-doc branch 2 times, most recently from 657fa24 to 3959752 Compare August 31, 2022 14:05
DEVELOPMENT.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@felix-gohla felix-gohla added the documentation Improvements or additions to documentation label Aug 31, 2022
@sirkrypt0 sirkrypt0 requested a review from felix-gohla August 31, 2022 16:50
Copy link
Contributor

@felix-gohla felix-gohla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some further things that came to my mind: The crypto implementations probably aren't completely safe (think of the AES-GCM code). We should note this somewhere.

Also: please add building instructions for x86.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@frcroth frcroth linked an issue Aug 31, 2022 that may be closed by this pull request
6 tasks
README.md Outdated Show resolved Hide resolved
@sirkrypt0 sirkrypt0 force-pushed the feature/more-doc branch 2 times, most recently from 5ee7c05 to c66fbe3 Compare August 31, 2022 17:24
README.md Outdated Show resolved Hide resolved
@sirkrypt0 sirkrypt0 merged commit 9ea5d43 into main Aug 31, 2022
@sirkrypt0 sirkrypt0 deleted the feature/more-doc branch August 31, 2022 17:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

Successfully merging this pull request may close these issues.

Improve docs
4 participants