Add documentation on how to generate and publish the documentation

loicteixeira · Apr 9, 2017 · e82a877 · e82a877
1 parent 0a06d37
commit e82a877
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/Documentation/README.md b/Documentation/README.md
@@ -0,0 +1,7 @@
+# Documentation
+
+## Generate
+Use [Doxygen](http://www.stack.nl/~dimitri/doxygen/) and load the `./Documentation/Doxyfile` configuration file.
+
+## Publish
+After updating the documentation, publish to GitHub Pages with `git subtree push --prefix Documentation/Output/html origin gh-pages`.