Add README to project root #1253
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| > 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 | ||
|
|
||
|  | ||
|
|
||
wentelteefje marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| [](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. | ||
|
|
||
|
Member
There was a problem hiding this comment. Not sure if we need to mention licensing, but many projects do.
Contributor
Author
There was a problem hiding this comment. I'm unsure about possible legal requirements -- but my suggestion is to add appropriate badges, e.g. like in the substrate readme. This is somewhat redundant, but I also think it's poor UX to be required to jump to all of the respective readme's to get that info.
Contributor
There was a problem hiding this comment. We should copy the licensing blurb from the substrate readme I would think.
Contributor
Author
There was a problem hiding this comment.
I've added badges to each project to reflect their respective licenses. I don't think it's really necessary to explain Substrate's split license in depth in the root readme. Am I missing something?
wentelteefje marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## 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) | ||
|
|
||
ggwpez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## Security | ||
|
|
||
| The security policy and procedures can be found in [docs/SECURITY.md](./docs/SECURITY.md). | ||
|
|
||
| ## Contributing & Code of Conduct | ||
|
|
||
wentelteefje marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.