mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-25 22:17:58 +00:00
Kevin Krone
ea5792508e
* Added root README.md draft * Modified Contribution section to reflect unified guidelines * Update README.md Co-authored-by: Squirrel <gilescope@gmail.com> * Expand Substrate description * Added Badges and Upstream deps * Fixed badge links * Fixed CONTRIBUTING.md links, added security and resources section to root README.md * Moved runtimes link to Polkadot section --------- Co-authored-by: Squirrel <gilescope@gmail.com> Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
57 lines
3.3 KiB
Markdown
57 lines
3.3 KiB
Markdown
> NOTE: We have recently made significant changes to our repository structure. In order to
|
|
streamline our development process and foster better contributions, we have merged three separate
|
|
repositories Cumulus, Substrate and Polkadot into this repository. Read more about the changes [
|
|
here](https://polkadot-public.notion.site/Polkadot-SDK-FAQ-fbc4cecc2c46443fb37b9eeec2f0d85f).
|
|
|
|
# Polkadot SDK
|
|
|
|
|
|
|
|
[](https://substrate.stackexchange.com/)
|
|
|
|
The Polkadot SDK repository provides all the resources needed to start building on the Polkadot
|
|
network, a multi-chain blockchain platform that enables different blockchains to interoperate and
|
|
share information in a secure and scalable way. The Polkadot SDK comprises three main pieces of
|
|
software:
|
|
|
|
## [Polkadot](./polkadot/)
|
|
[](https://forum.polkadot.network/) [](./polkadot/LICENSE)
|
|
|
|
Implementation of a node for the https://polkadot.network in Rust, using the Substrate framework.
|
|
This directory currently contains runtimes for the Polkadot, Kusama, Westend, and Rococo networks.
|
|
In the future, these will be relocated to the [`runtimes`](https://github.com/polkadot-fellows/runtimes/) repository.
|
|
|
|
## [Substrate](./substrate/)
|
|
[](https://paritytech.github.io/substrate/master/substrate/index.html) [](./substrate/README.md#LICENSE)
|
|
|
|
Substrate is the primary blockchain SDK used by developers to create the parachains that make up
|
|
the Polkadot network. Additionally, it allows for the development of self-sovereign blockchains
|
|
that operate completely independently of Polkadot.
|
|
|
|
## [Cumulus](./cumulus/)
|
|
[](https://paritytech.github.io/cumulus/cumulus_client_collator/index.html) [](./cumulus/LICENSE)
|
|
|
|
Cumulus is a set of tools for writing Substrate-based Polkadot parachains.
|
|
|
|
## Upstream Dependencies
|
|
|
|
Below are the primary upstream dependencies utilized in this project:
|
|
|
|
- [parity-scale-codec](https://crates.io/crates/parity-scale-codec)
|
|
- [parity-db](https://crates.io/crates/parity-db)
|
|
- [parity-common](https://github.com/paritytech/parity-common)
|
|
- [trie](https://github.com/paritytech/trie)
|
|
|
|
## Security
|
|
|
|
The security policy and procedures can be found in [docs/SECURITY.md](./docs/SECURITY.md).
|
|
|
|
## Contributing & Code of Conduct
|
|
|
|
Ensure you follow our [contribution guidelines](./docs/CONTRIBUTING.md). In every interaction and contribution, this project adheres to the [Contributor Covenant Code of Conduct](./docs/CODE_OF_CONDUCT.md).
|
|
|
|
## Additional Resources
|
|
|
|
- For monitoring upcoming changes and current proposals related to the technical implementation of the Polkadot network, visit the [`Requests for Comment (RFC)`](https://github.com/polkadot-fellows/RFCs) repository. While it's maintained by the Polkadot Fellowship, the RFC process welcomes contributions from everyone.
|
|
|