Skip to content

Commit 9506344

Browse files
Create README.md
1 parent 6d1f855 commit 9506344

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

Diff for: README.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# whisky-book
2+
3+
Documentation for Whisky.
4+
5+
### How to Contribute
6+
1. Install [rust](https://www.rust-lang.org/tools/install)
7+
2. Install mdbook and the required preprocessors
8+
```
9+
cargo install mdbook
10+
cargo install mdbook-alerts
11+
cargo isntall mdbook-template
12+
```
13+
3. You can preview changes to the book with `mdbook serve --open`

0 commit comments

Comments
 (0)