Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Use README as crate docs#537

Merged
newpavlov merged 4 commits into
master from
readme_docs
Jan 10, 2024
Merged

Use README as crate docs #537
newpavlov merged 4 commits into
master from
readme_docs

Conversation

@newpavlov

@newpavlov newpavlov commented Jan 10, 2024
edited
Loading

Copy link
Copy Markdown
Member

Moves all crate-level docs to appropriate READMEs. Additionally, adds some cleanups made possible by migration to hybrid-array and hex-literal v0.4.

Comment thread blake2/Cargo.toml
simd_asm = ["simd_opt"]
#simd = []
#simd_opt = ["simd"]
#simd_asm = ["simd_opt"]

@newpavlov newpavlov Jan 10, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

We probably should finish #228 before publishing blake2 v0.11.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yeah, definitely been meaning to do it. Would be great to get it over the finish line.

Comment thread sha2/README.md Outdated
Comment thread sha2/README.md
There are 6 standard algorithms specified in the SHA-2 standard:
[`Sha224`], [`Sha256`], [`Sha512_224`], [`Sha512_256`], [`Sha384`], and [`Sha512`].

<img src="https://raw.githubusercontent.com/RustCrypto/meta/master/img/hashes/sha2.png" width="480px">

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Aww 😄

@newpavlov newpavlov Jan 10, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I think most users of the crate (and thus readers of the doc) would not care for this pretty picture. :)

@newpavlov newpavlov Jan 10, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I can add it after examples if you want.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Whatever

Comment thread skein/README.md Outdated
@newpavlov newpavlov merged commit f5a07e6 into master Jan 10, 2024
@newpavlov newpavlov deleted the readme_docs branch January 10, 2024 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tarcieri tarcieri tarcieri approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /