diff options
author | Thibault Saunier <thibault.saunier@osg.samsung.com> | 2017-03-29 15:03:43 -0300 |
---|---|---|
committer | Jussi Pakkanen <jpakkane@gmail.com> | 2017-04-26 17:56:33 +0300 |
commit | b371875e02cce2fb3fbb9fbb8f07eb5817ae0e8f (patch) | |
tree | 6e1a3c34b1a85479d3b9f42ccd071096e637929b /docs/README.md | |
parent | 7dc747ea54480c452b913e4bfe682ec67061c9bf (diff) | |
download | meson-b371875e02cce2fb3fbb9fbb8f07eb5817ae0e8f.zip meson-b371875e02cce2fb3fbb9fbb8f07eb5817ae0e8f.tar.gz meson-b371875e02cce2fb3fbb9fbb8f07eb5817ae0e8f.tar.bz2 |
docs: Import the website and wiki and build with hotdoc
This allows us to more easily have the documentation in sync with
the source code as people will have to document new features etc
right at the time where they implement it.
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 + |