summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian <sebix@sebix.at>2016-09-15 22:29:25 +0200
committerGitHub <noreply@github.com>2016-09-15 22:29:25 +0200
commit2e3512c656409e53df29b93192e239f08f50348b (patch)
treed27c1f714ea12ab9ec8e335162cc1957d8744f0d
parent4c6072f61b9e696afe50e74bf2766cd1418cb228 (diff)
downloadpython-systemd-2e3512c656409e53df29b93192e239f08f50348b.tar.gz
Add Docs to README
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index fe5919c..abd83d6 100644
--- a/README.md
+++ b/README.md
@@ -79,6 +79,17 @@ Notes:
This might happen if there are no arguments or one of them is
invalid.
+Documentation
+=============
+
+Online documentation can be found at [freedesktop.org](https://www.freedesktop.org/software/systemd/python-systemd/)
+
+To build it locally run:
+
+ make sphinx-html
+
+Or use any other builder, see `man sphinx-build` for a list. The compiled docs will be e.g. in `docs/html`.
+
Viewing Output
==============