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 docs for the common binaries exported from Polkadot SDK #5305

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

shawntabrizi
Copy link
Member

This PR updates the main README file to introduce a simple command to install the most commonly used binaries from the Polkadot SDK used for development.

In many cases, as a developer using the Polkadot SDK, these are the main things you would want to access from the polkadot-sdk repo, so I think it is key to highlight how you can easily get those binaries.

For other platforms, you can compile the binaries yourself with:

```bash
cargo install --git https://github.com/paritytech/polkadot-sdk/ --tag polkadot-stable2407 polkadot polkadot-parachain-bin staging-chain-spec-builder
Copy link
Member

@ggwpez ggwpez Aug 9, 2024

Choose a reason for hiding this comment

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

I think it also needs the polkadot-execute-worker and polkadot-prepare-worker binaries to work?
Slightly unfortunate, but we split the polkadot binary into three (for security reasons) 🫠

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, you need those to run a node as validator.

Copy link
Member Author

Choose a reason for hiding this comment

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

Where can i learn how these other 2 binaries work and what they do?

Copy link
Contributor

Choose a reason for hiding this comment

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

See here for more info: paritytech/polkadot#7337

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.

4 participants