From c33c146a174296cb16f83a722b006633c441ed29 Mon Sep 17 00:00:00 2001 From: Danilo Bargen Date: Sat, 14 Nov 2020 23:55:49 +0100 Subject: [PATCH] Docs: Add README --- docs/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..7b63a06 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,8 @@ +# Tealdeer Docs + +To build the docs, install [mdbook](https://github.com/rust-lang/mdBook). + +You can build the HTML with `mdbook build`. + +To serve the docs on `localhost:3000` and watch for changes, use `mdbook +serve`.