diff options
authorElena ``of Valhalla'' Grandi <valhalla@trueelena.org>2017-01-03 17:05:18 +0100
committerElena ``of Valhalla'' Grandi <valhalla@trueelena.org>2017-01-03 17:05:18 +0100
commite5bfe66fb894294fdae91a6ab944d8447a48ec20 (patch)
parent93ffa91f26e2238963add5f91b4d792ffd2ee14f (diff)
installation instructions
1 files changed, 22 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 2ce1973..d8a4a5a 100644
--- a/README.rst
+++ b/README.rst
@@ -22,3 +22,25 @@ Some example collection schemas are provided, but one big strenght of
lesana is the ability to customize your collection with custom fields
either by simply writing a personalize schema.yaml or, in more complex
cases, by inheriting from it in another module.
+lesana expects to run on a POSIX-like system and requires the following
+* python3
+* `guacamole <https://github.com/zyga/guacamole/>`_
+* xapian_
+* `ruamel.yaml <https://bitbucket.org/ruamel/yaml>`_
+* `jinja2 <http://jinja.pocoo.org/>`_
+* `GitPython <https://github.com/gitpython-developers/GitPython>`_
+ optional, to add git support.
+Under debian (and derivatives), the packages to install are::
+ apt install python3-guacamole python3-jinja2 python3-ruamel.yaml \
+ python3-xapian python3-git
+(some of those are only available on stretch-onwards because earlier
+versions lacked python3 support.)