aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKostiantyn Ponomarenko <konstantin.ponomarenko@gmail.com>2018-09-27 11:05:32 +0300
committerNirbheek Chauhan <nirbheek.chauhan@gmail.com>2018-09-27 01:43:22 -0700
commite53be9c925eacfcf0f1826103a7dc9bf4c417ca9 (patch)
treee86027a8759168b99592039a9cb747cc9dafa77e
parentf0c4d1cd00da1f6e7d0126a156928e242d6c5b8b (diff)
downloadmeson-e53be9c925eacfcf0f1826103a7dc9bf4c417ca9.zip
meson-e53be9c925eacfcf0f1826103a7dc9bf4c417ca9.tar.gz
meson-e53be9c925eacfcf0f1826103a7dc9bf4c417ca9.tar.bz2
Update Meson docs README [skip ci]
Signed-off-by: Kostiantyn Ponomarenko <konstantin.ponomarenko@gmail.com>
-rw-r--r--docs/README.md37
1 files changed, 31 insertions, 6 deletions
diff --git a/docs/README.md b/docs/README.md
index 18509c7..55fc3ec 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,15 +1,40 @@
-# Building the documentation
+# Meson Documentation
-1. Get [hotdoc](https://hotdoc.github.io/installing.html) (0.8.9 required)
-1. Run hotdoc in the docs/ directory:
+## Build dependencies
- ../meson/meson.py build/
+Meson uses itself and [hotdoc](https://github.com/hotdoc/hotdoc) for generating documentation.
+
+Minimum required version of hotdoc is *0.8.9*.
+
+Instructions on how to install hotdoc are [here](https://hotdoc.github.io/installing.html).
+
+## Building the documentation
+
+From the Meson repository root dir:
+```
+$ cd docs/
+$ meson built_docs
+$ ninja -C built_docs/ upload
+```
+Now you should be able to open the documentation locally
+```
+built_docs/Meson documentation-doc/html/index.html
+```
## Upload
-We are using the git-upload hotdoc plugin which basically
+Meson uses the git-upload hotdoc plugin which basically
removes the html pages and replaces with the new content.
You can simply run:
+```
+$ ninja -C built_docs/ upload
+```
+
+## Contributing to the documentation
- ninja -C build/ upload
+Commits that only change documentation should have `[skip ci]` in their commit message, so CI is not run (it is quite slow).
+For example:
+```
+A commit message [skip ci]
+```