Add README
This commit is contained in:
parent
aa63c82030
commit
2c3c9107d2
|
|
@ -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`.
|
||||||
Loading…
Reference in New Issue