summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorOmniscient <omniscient.oce@gmail.com>2024-05-20 10:48:01 +1000
committerOmniscient <omniscient.oce@gmail.com>2024-05-20 10:48:01 +1000
commitc91f86bd744df6f93a93e61d030c55393fb9ef0d (patch)
tree8f8dddade96b420d36489b2f03d0b791628d44aa /README.md
parent5e2186b753c0058253299a651e5752776b88066c (diff)
parent02e84ee4d18e705e3362be1e327fdb6f1397a032 (diff)
Merge branch 'master' into realign
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6a2545d..ccd9652 100644
--- a/README.md
+++ b/README.md
@@ -20,3 +20,9 @@ All third-party dependencies are licensed under their own license.
* Lint (no change) `find src/ -iname *.h -o -iname *.c | xargs clang-format --style=file --dry-run --Werror`
* Format (edit in place) `find src/ \( -iname "*.h" -o -iname "*.c" \) | xargs clang-format -i --style=file`
* `clang-format` must be installed!
+* Documentation
+ * serve mkdocs locally
+ * `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material`
+
+ * Build docs static site
+ * `docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material build`