Skip to content

Commit e262b61

Browse files
committed
update readme
1 parent b912174 commit e262b61

File tree

2 files changed

+36
-15
lines changed

2 files changed

+36
-15
lines changed

.github/workflows/pages.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ jobs:
4646
run: mdbook build
4747
- name: Embed `html-slides` into `html-book`, fix relative paths
4848
run: |
49-
rsync -av html-slides/content/ html-book/ --ignore-existing
50-
rsync -av html-slides/ --exclude 'content' html-book/ --ignore-existing
49+
rsync -av html-slides/content/ html-book/
50+
rsync -av html-slides/ --exclude 'content' html-book/
5151
find html-book/ -regex .*\.html | xargs sed -i'' -e 's#./../../../#../../#g' > /dev/null
5252
5353
# TODO: Without making a _branch_ that bloats the .git object,

content/README.md

Lines changed: 34 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,34 @@
1-
# Syllabus
2-
3-
| Module | Name |
4-
| ------ | ------------------------------------------------------------------------------------------------------------ |
5-
| 1 | [Cryptography for Blockchain](./1-Cryptography/index.md) |
6-
| 2 | [Interdisciplinary Concepts for Decentralized Devs (Econ, Polisci)](./2-Economics/index.md) |
7-
| 3 | [Blockchain](./3-Blockchain/index.md) |
8-
| 4 | [Core and Basics](./4-Core_and_Basics/index.md) |
9-
| 5 | [PVM, Polkadot Architecture and Smart Contracts](./5-PVM-Polkadot-Architecture-and-Smart-Contracts/index.md) |
10-
| 6 | [Protocol track (Polkadot Cloud)](./6-Protocol_On-Chain/index.md) |
11-
| 7 | [dApps track (Polkadot Hub)](./7-dApps_Off-Chain/index.md) |
12-
| 8 | [Governance](./8-Governance/index.md) |
13-
| 9 | [Polkadot, JAM and the future](./9-Polkadot/index.md) |
1+
# Course Materials Book
2+
3+
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).
4+
5+
## Read the Book
6+
7+
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.
8+
9+
### Hosted Online
10+
11+
The latest version is hosted at: <a target="_blank" href="https://polkadot-blockchain-academy.github.io/pba-book/">https://polkadot-blockchain-academy.github.io/pba-book/</a>
12+
13+
### Build Offline
14+
15+
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.
16+
17+
In order to `make` your life easy 😉, there is a set of tasks that use [`cargo make`](https://sagiegurari.github.io/cargo-make/#overview).
18+
19+
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:
20+
21+
```sh
22+
# Run from the top-level working dir of this repo
23+
makers --list-all-steps
24+
```
25+
26+
The tasks should be self-explanatory, if they are not - please file an issue to help us make them better.
27+
28+
## License and Use Policies
29+
30+
All materials found within this repository are licensed under Mozilla Public License Version 2.0 - See the [License](./LICENSE.md) for details.
31+
32+
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.
33+
34+
<h3 align="center"><a href="https://dot.li/pba-github">Learn more about and apply for the next Academy today!</a></h3>

0 commit comments

Comments
 (0)