Files
pezkuwi-subxt/substrate/README.md
T
Joyce Siqueira c80f76f187 update polkadot, substrate, cumulus readme (#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 <liam.aharon@hotmail.com>

* Update cumulus/README.md

Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>

* Update cumulus/README.md

Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>

* Update polkadot/README.md

Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>

* Update polkadot/README.md

Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>

* Update polkadot/README.md

Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>

* update gitlab links

Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>

* terminal friendly convention

---------

Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>
2023-08-29 14:37:16 +03:00

45 lines
2.7 KiB
Markdown

# 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/)
<p align="center">
<img src="/docs/media/sub.gif">
</p>
Substrate is a next-generation framework for blockchain innovation 🚀.
## Getting Started
Head to [docs.substrate.io](https://docs.substrate.io) and follow the
[installation](https://docs.substrate.io/install/) instructions. Then try out one of the
[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.
## Community & Support
Join the highly active and supportive community on the
[Substrate Stack Exchange](https://substrate.stackexchange.com/) to ask questions about use and problems you run into using this software.
Please do report bugs and [issues here](https://github.com/paritytech/polkadot-sdk/issues) for anything you suspect requires action in the source.
## Contributions & Code of Conduct
Please follow the contributions guidelines as outlined in
[`docs/CONTRIBUTING.md`](https://github.com/paritytech/polkadot-sdk/blob/master/docs/CONTRIBUTING.md).
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).
## Security
The security policy and procedures can be found in
[`docs/SECURITY.md`](https://github.com/paritytech/polkadot-sdk/blob/master/docs/SECURITY.md).
## License
- Substrate Primitives (`sp-*`), Frame (`frame-*`) and the pallets (`pallets-*`), binaries (`/bin`)
and all other utilities are licensed under [Apache 2.0](LICENSE-APACHE2). - Substrate Client
(`/client/*` / `sc-*`) is licensed under [GPL v3.0 with a classpath linking
exception](LICENSE-GPL3).
The reason for the split-licensing is to ensure that for the vast majority of teams using Substrate
to create feature-chains, then all changes can be made entirely in Apache2-licensed code, allowing
teams full freedom over what and how they release and giving licensing clarity to commercial teams.
In the interests of the community, we require any deeper improvements made to Substrate's core logic
(e.g. Substrate's internal consensus, crypto or database code) to be contributed back so everyone
can benefit.