update documentation

[software/DIPE.git] / doc / source / install.rst

diff --git a/doc/source/install.rst b/doc/source/install.rst
new file mode 100644 (file)
index 0000000..c7cc5f6
--- /dev/null
+++ b/doc/source/install.rst
@@ -0,0 +1,16 @@
+Installation
+============
+
+Get the code from `git.siccegge.de
+<https://git.siccegge.de/?p=software/DIPE.git;a=summary>`_.
+Installing dependencies on debian requires a manual installation of
+`PBC <https://crypto.stanford.edu/pbc/>`_ and the packages ``googletest
+cmake nettle-dev libgmp-dev``. Standard out-of-tree-build via::
+
+  mkdir build
+  cd build
+  cmake ..
+  make -j
+
+The googletest integration is expected to need manual fiddling on
+non-Debian and probably also on Debian systems.