diff --git a/content/README.md b/content/README.md index 38005a7..254708a 100644 --- a/content/README.md +++ b/content/README.md @@ -1,34 +1,13 @@ -# Course Materials Book - -This book is the home of the majority of materials used within the dApps and Protocol Tracks of the [Polkadot Blockchain Academy](https://polkadot.academy). - -## Read the Book - -We suggest the [online](#hosted-online) version for general use, but cloning, installing, and building this book [offline](#build-offline) is a great option on-the-go. - -### Hosted Online - -The latest version is hosted at: https://polkadot-blockchain-academy.github.io/pba-book/ - -### Build Offline - -The Protocol Track of the Academy is Rust _heavy_ and as such, you need to [install rust](https://www.rust-lang.org/tools/install) before you can continue. - -In order to `make` your life easy 😉, there is a set of tasks that use [`cargo make`](https://sagiegurari.github.io/cargo-make/#overview). - -With [`cargo make`](https://sagiegurari.github.io/cargo-make/#installation) installed, you can list all tasks included to facilitate further installation, building, serving, formatting, and more with: - -```sh -# Run from the top-level working dir of this repo -makers --list-all-steps -``` - -The tasks should be self-explanatory, if they are not - please file an issue to help us make them better. - -## License and Use Policies - -All materials found within this repository are licensed under Mozilla Public License Version 2.0 - See the [License](./LICENSE.md) for details. - -In addition to the license, we ask you read and respect the Academy's [Code of Conduct](./CODE-OF-CONDUCT.md) and help us foster a healthy and scholarly community of high academic integrity. - -