Skip to content

Commit c388180

Browse files
update polkadot, substrate, cumulus readme (paritytech#1182)
* update readmes * temporary ReadMe for the Polkadot SDK * delete welcome readme * update links on substrate readme * update links on polkadot readme * update links on cumulus readme * update overseer feature comment Co-authored-by: Liam Aharon <[email protected]> * Update cumulus/README.md Co-authored-by: Liam Aharon <[email protected]> * Update cumulus/README.md Co-authored-by: Liam Aharon <[email protected]> * Update polkadot/README.md Co-authored-by: Liam Aharon <[email protected]> * Update polkadot/README.md Co-authored-by: Liam Aharon <[email protected]> * Update polkadot/README.md Co-authored-by: Liam Aharon <[email protected]> * update gitlab links Co-authored-by: Liam Aharon <[email protected]> * terminal friendly convention --------- Co-authored-by: Liam Aharon <[email protected]>
1 parent c90a324 commit c388180

File tree

1 file changed

+38
-7
lines changed

1 file changed

+38
-7
lines changed

substrate/README.md

Lines changed: 38 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,44 @@
1-
Dear contributors and users,
1+
# Substrate &middot; [![GitHub license](https://img.shields.io/badge/license-GPL3%2FApache2-blue)](#LICENSE) [![GitLab Status](https://gitlab.parity.io/parity/mirrors/polkadot-sdk/badges/master/pipeline.svg)](https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/pipelines) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](docs/CONTRIBUTING.md) [![Stack Exchange](https://img.shields.io/badge/Substrate-Community%20&%20Support-24CC85?logo=stackexchange)](https://substrate.stackexchange.com/)
2+
<p align="center">
3+
<img src="/docs/media/sub.gif">
4+
</p>
25

3-
We would like to inform you that 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 a single new repository: [the Polkadot SDK](https://github.com/paritytech/polkadot-sdk). Go ahead and make sure to support us by giving a star ⭐️ to the new repo.
6+
Substrate is a next-generation framework for blockchain innovation 🚀.
47

5-
By consolidating our codebase, we aim to enhance collaboration and provide a more efficient platform for future development.
8+
## Getting Started
69

7-
If you currently have an open pull request in any of the merged repositories, we kindly request that you resubmit your PR in the new repository. This will ensure that your contributions are considered within the updated context and enable us to review and merge them more effectively.
10+
Head to [docs.substrate.io](https://docs.substrate.io) and follow the
11+
[installation](https://docs.substrate.io/install/) instructions. Then try out one of the
12+
[tutorials](https://docs.substrate.io/tutorials/). Refer to the [Docker instructions](./docker/README.md) to quickly run Substrate, Substrate Node Template, Subkey, or to build a chain spec.
813

9-
We appreciate your understanding and ongoing support throughout this transition. Should you have any questions or require further assistance, please don't hesitate to [reach out to us](https://forum.polkadot.network/t/psa-parity-is-currently-working-on-merging-the-polkadot-stack-repositories-into-one-single-repository/2883).
14+
## Community & Support
1015

11-
Best Regards,
16+
Join the highly active and supportive community on the
17+
[Substrate Stack Exchange](https://substrate.stackexchange.com/) to ask questions about use and problems you run into using this software.
18+
Please do report bugs and [issues here](https://github.com/paritytech/polkadot-sdk/issues) for anything you suspect requires action in the source.
1219

13-
Parity Technologies
20+
## Contributions & Code of Conduct
21+
22+
Please follow the contributions guidelines as outlined in
23+
[`docs/CONTRIBUTING.md`](https://github.com/paritytech/polkadot-sdk/blob/master/docs/CONTRIBUTING.md).
24+
In all communications and contributions, this project follows the [Contributor Covenant Code of Conduct](https://github.com/paritytech/polkadot-sdk/blob/master/docs/CODE_OF_CONDUCT.md).
25+
26+
## Security
27+
28+
The security policy and procedures can be found in
29+
[`docs/SECURITY.md`](https://github.com/paritytech/polkadot-sdk/blob/master/docs/SECURITY.md).
30+
31+
## License
32+
33+
- Substrate Primitives (`sp-*`), Frame (`frame-*`) and the pallets (`pallets-*`), binaries (`/bin`)
34+
and all other utilities are licensed under [Apache 2.0](LICENSE-APACHE2). - Substrate Client
35+
(`/client/*` / `sc-*`) is licensed under [GPL v3.0 with a classpath linking
36+
exception](LICENSE-GPL3).
37+
38+
The reason for the split-licensing is to ensure that for the vast majority of teams using Substrate
39+
to create feature-chains, then all changes can be made entirely in Apache2-licensed code, allowing
40+
teams full freedom over what and how they release and giving licensing clarity to commercial teams.
41+
42+
In the interests of the community, we require any deeper improvements made to Substrate's core logic
43+
(e.g. Substrate's internal consensus, crypto or database code) to be contributed back so everyone
44+
can benefit.

0 commit comments

Comments
 (0)