Create README.md

Whisky-App · Apr 3, 2024 · 9506344 · 9506344
1 parent 6d1f855
commit 9506344
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,13 @@
+# whisky-book
+
+Documentation for Whisky.
+
+### How to Contribute
+1. Install [rust](https://www.rust-lang.org/tools/install)
+2. Install mdbook and the required preprocessors
+   ```
+   cargo install mdbook
+   cargo install mdbook-alerts
+   cargo isntall mdbook-template
+   ```
+3. You can preview changes to the book with `mdbook serve --open`