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

Update Rust project READMEs #1073

Open
wants to merge 19 commits into
base: master
Choose a base branch
from
Open

Conversation

jessiemongeon1
Copy link
Contributor

@jessiemongeon1 jessiemongeon1 commented Dec 19, 2024

The example README files are no longer used on the Dev Docs, so the keyword tags and format can be adjusted to read best on GitHub.

Each README has also been updated to fit latest style guide practices.

@jessiemongeon1 jessiemongeon1 requested review from a team as code owners December 19, 2024 21:40
berestovskyy
berestovskyy previously approved these changes Dec 19, 2024
"
gregorydemay
gregorydemay previously approved these changes Dec 20, 2024
Copy link
Member

@gregorydemay gregorydemay left a comment

Choose a reason for hiding this comment

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

Thanks for the clean-up, cross-chain changes LGTM!

@gregorydemay gregorydemay requested a review from a team December 20, 2024 06:41
oggy-dfin
oggy-dfin previously approved these changes Dec 23, 2024
rust/x509/README.md Outdated Show resolved Hide resolved
rust/x509/README.md Outdated Show resolved Hide resolved
rust/x509/README.md Outdated Show resolved Hide resolved
rust/threshold-ecdsa/README.md Show resolved Hide resolved
rust/threshold-ecdsa/README.md Outdated Show resolved Hide resolved
rust/threshold-schnorr/README.md Outdated Show resolved Hide resolved
rust/threshold-schnorr/README.md Show resolved Hide resolved
rust/threshold-schnorr/README.md Outdated Show resolved Hide resolved
rust/threshold-schnorr/README.md Outdated Show resolved Hide resolved
rust/threshold-schnorr/README.md Show resolved Hide resolved
rust/threshold-ecdsa/README.md Outdated Show resolved Hide resolved
rust/threshold-ecdsa/README.md Outdated Show resolved Hide resolved
rust/threshold-schnorr/README.md Outdated Show resolved Hide resolved
rust/threshold-schnorr/README.md Outdated Show resolved Hide resolved
rust/threshold-schnorr/README.md Outdated Show resolved Hide resolved
rust/threshold-schnorr/README.md Outdated Show resolved Hide resolved
rust/threshold-schnorr/README.md Show resolved Hide resolved
rust/threshold-schnorr/README.md Outdated Show resolved Hide resolved
rust/threshold-schnorr/README.md Show resolved Hide resolved
rust/threshold-schnorr/README.md Show resolved Hide resolved
rust/x509/README.md Outdated Show resolved Hide resolved
rust/x509/README.md Outdated Show resolved Hide resolved
rust/x509/README.md Outdated Show resolved Hide resolved
rust/threshold-schnorr/README.md Outdated Show resolved Hide resolved
rust/threshold-schnorr/README.md Show resolved Hide resolved
rust/threshold-schnorr/README.md Outdated Show resolved Hide resolved
rust/threshold-schnorr/README.md Outdated Show resolved Hide resolved
rust/threshold-schnorr/README.md Outdated Show resolved Hide resolved
Copy link
Member

@fspreiss fspreiss left a comment

Choose a reason for hiding this comment

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

Thanks for addressing the comments, @jessiemongeon1. I have one final comment.


### Deploy and test the canister locally
## Step 1: Setup the project environment
Copy link
Member

Choose a reason for hiding this comment

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

Maybe group Step 1 and Step 2 (and possibly the Prerequisites) into a Local Deployment parent, similar to how you did the same in the Motoko READMEs in the other PR.

Same for threshold-schnorr.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants