From 2c3c9107d2fb4b54245ff9e7c82763656d46e8e4 Mon Sep 17 00:00:00 2001 From: Yakov5776 Date: Sat, 8 Oct 2022 23:32:41 -0400 Subject: [PATCH] Add README --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5aff317 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# What is this? +TODO + +# How do I build this? +This project uses material mkdocs. + +To install materal mkdocs, simply run: + + pip install mkdocs-material + +Then run `mkdocs serve` to preview it. + +You can also build it into static html files using `mkdocs build`. \ No newline at end of file