Skip to content

Commit fc45895

Browse files
committed
Add instructions in README
1 parent e4fcd8c commit fc45895

File tree

1 file changed

+32
-14
lines changed

1 file changed

+32
-14
lines changed

README.md

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,13 @@ wide developer audience to understand the protocol and build Cardano components.
1414

1515
## Building
1616

17-
The blueprints are written using markdown and can be viewed
18-
[directly in Github](./src/introduction/README.md) or built into
19-
[the HTML site](https://cardano-scaling.github.io/cardano-blueprint)
20-
using [mdbook][mdbook].
17+
The blueprints are written using markdown and can be viewed [directly in
18+
Github](./src/introduction/README.md) or built into [the HTML
19+
site](https://cardano-scaling.github.io/cardano-blueprint) using [mdbook].
2120

2221
### With cargo
2322

24-
You can install [mdbook][mdbook] and the plugins we use with `cargo`:
23+
You can install [mdbook] and the plugins we use with `cargo`:
2524

2625
```shell
2726
cargo install mdbook mdbook-katex mdbook-mermaid mdbook-alerts mdbook-toc
@@ -47,16 +46,16 @@ cargo binstall mdbook mdbook-katex mdbook-mermaid mdbook-alerts mdbook-toc
4746

4847
### With nix
4948

50-
You can also use [nix][nix]:
49+
You can also use [nix]:
5150

5251
```shell
5352
nix build -o out
5453
```
5554

5655
## Editing
5756

58-
With [mdbook][mdbook] installed or inside a `nix develop` shell, you
59-
can live preview the result with:
57+
With [mdbook] installed or inside a `nix develop` shell, you can live preview
58+
the result with:
6059

6160
```shell
6261
mdbook serve --open
@@ -65,20 +64,39 @@ mdbook serve --open
6564
See the [mdbook manual][mdbook] or [github flavored markdown][gfm] for
6665
more information on what is available for editing.
6766

68-
[mdbook]: https://rust-lang.github.io/mdBook/index.html
69-
[gfm]: https://github.github.com/gfm/
70-
[nix]: https://nixos.org/download.html
67+
### Formatting & spell checking
68+
69+
We use `treefmt` that runs a few formatting and spell checking tools. This is
70+
also enforced through CI. See `formattingPkgs` in [`flake.nix`](./flake.nix) for
71+
a list of packages needed, then:
72+
73+
```shell
74+
treefmt
75+
```
7176

7277
## License
7378

74-
Cardano Blueprint created by [the Cardano Blueprint contributors](https://github.com/cardano-scaling/cardano-blueprint/graphs/contributors) is licensed under the [Apache 2.0 License](./LICENSE).
79+
Cardano Blueprint created by [the Cardano Blueprint
80+
contributors](https://github.com/cardano-scaling/cardano-blueprint/graphs/contributors)
81+
is licensed under the [Apache 2.0 License](./LICENSE).
7582

7683
## Logo
7784

78-
The [logo and wordmark](./logo/README.md) for the Cardano Blueprint was created by Roberto Nicolo, Sebastian Nagel and Input Output Global Ltd. Obviously, the design is derived from the official Cardano logo and we hereby accept and intend to follow the [official trademark policy](https://www.cardanofoundation.org/policy/trademark-policy). Cardano Blueprint is NOT registered as a trademark, nor shall it represent a commercial product, but any artifacts produced are covered under an open source [license](./LICENSE).
85+
The [logo and wordmark](./logo/README.md) for the Cardano Blueprint was created
86+
by Roberto Nicolo, Sebastian Nagel and Input Output Global Ltd. Obviously, the
87+
design is derived from the official Cardano logo and we hereby accept and intend
88+
to follow the [official trademark
89+
policy](https://www.cardanofoundation.org/policy/trademark-policy). Cardano
90+
Blueprint is NOT registered as a trademark, nor shall it represent a commercial
91+
product, but any artifacts produced are covered under an open source
92+
[license](./LICENSE).
7993

80-
---
94+
______________________________________________________________________
8195

8296
<p align="center">
8397
Thanks for visiting and hopefully the cardano blueprint is useful to you 💙!
8498
</p>
99+
100+
[gfm]: https://github.github.com/gfm/
101+
[mdbook]: https://rust-lang.github.io/mdBook/index.html
102+
[nix]: https://nixos.org/download.html

0 commit comments

Comments
 (0)