diff options
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..61d2e05 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,16 @@ +# Building the documentation + +1. Get [hotdoc](https://hotdoc.github.io/installing.html) (0.8.9 required) +1. Run hotdoc: + + hotdoc run + +## Upload + +We are using the git-upload hotdoc plugin which basically +removes the html pages and replaces with the new content. + +You can simply run: + + hotdoc run --git-upload-activate + |