From 90accf7b0476e163b5b62694320333319e340752 Mon Sep 17 00:00:00 2001 From: Alex Tereschenko Date: Tue, 17 Nov 2015 21:19:31 +0100 Subject: [PATCH] README.md: added install instructions per suggestion in #336. Closes #336. Signed-off-by: Alex Tereschenko Signed-off-by: Brendan Le Foll --- docs/building.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/docs/building.md b/docs/building.md index 1d57752..7912d13 100644 --- a/docs/building.md +++ b/docs/building.md @@ -14,6 +14,12 @@ what you'll need: * [node.js](http://nodejs.org) 0.10.x or 0.12.x (you'll need not just the interpreter but nodejs-dev) * [CMake](http://cmake.org) 2.8.8+ +For Debian-like distros the below command installs the basic set: + +```bash +sudo apt-get install git build-essential swig3.0 python-dev nodejs-dev cmake +``` + To build the documentation you'll also need: * [Doxygen](http://www.stack.nl/~dimitri/doxygen/) 1.8.9.1+ * [Graphviz](http://graphviz.org/) 2+ (For doxygen graph generation) @@ -33,6 +39,29 @@ If this goes wrong and you have all the dependencies installed, then please file an issue with the full output of `cmake ..` and `make` or however far you got. +After that you can install built files (into default path) by running: + + +```bash +sudo make install +``` + +See flags for adjusting install paths in the section below. + +Currently our install logic puts Python bindings into standard paths, which +do not work on Debian due to their + [policy](http://www.debian.org/doc/packaging-manuals/python-policy/ch-python.html#s-paths). + +We are working on a permanent solution, in the meanwhile please use this command +after `make install` to link installed modules where Debian's Python expects them: + +```bash +sudo ln -s /lib/python2.7/site-packages/* /usr/lib/python2.7/dist-packages +``` + +Same approach works for Python 3, you'll just need to adjust the version number +in the path accordingly. + ## Configuration flags Our cmake configure has a number of options, cmake-gui or ccmake (cmake -i is -- 2.7.4