aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorbozo.kopic <bozo.kopic@gmail.com>2017-08-18 15:24:16 +0200
committerbozo.kopic <bozo.kopic@gmail.com>2017-08-18 15:24:16 +0200
commit6424cbc7cef9185564c5e3574575b4a5e617b9cb (patch)
tree82b04cc2e3344a9743d67acf9fce4c6be6e005f5 /README.rst
parent6e52ded7a8c4e49102f7a10a942f65e4490ea3bd (diff)
documentation
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst12
1 files changed, 7 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index 533ade8..015e8a7 100644
--- a/README.rst
+++ b/README.rst
@@ -18,8 +18,9 @@ Runtime requirements
--------------------
* python >=3.6
+* libvirt
-Additional required python packages are listed in `requirements.pip.txt`.
+Additional required python packages are listed in `requirements.pip.run.txt`.
Development requirements
@@ -28,20 +29,22 @@ Development requirements
* nodejs >=7
* yarn
+Additional required python packages are listed in `requirements.pip.dev.txt`.
+
Documentation
-------------
-Online documentation available at `http://hatter.readthedocs.io`.
+Online documentation available at `<http://hatter.readthedocs.io>`_.
Build
-----
-Build tool used for Hatter is pydoit (`http://pydoit.org/`). It can be
+Build tool used for Hatter is pydoit (`<http://pydoit.org>`_). It can be
installed together with other python dependencies by running::
- $ pip install -r requirements.pip.txt
+ $ pip install -r requirements.pip.dev.txt
For listing available doit tasks, use::
@@ -71,6 +74,5 @@ TODO
* other
- * documentation
* write complete setup.py
* distribution