From b371875e02cce2fb3fbb9fbb8f07eb5817ae0e8f Mon Sep 17 00:00:00 2001 From: Thibault Saunier Date: Wed, 29 Mar 2017 15:03:43 -0300 Subject: 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. --- docs/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 docs/README.md (limited to 'docs/README.md') diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..61d2e052d --- /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 + -- cgit v1.2.3