Private
Public Access
2
0

README.md: added install instructions per suggestion in #336.

Closes #336.

Signed-off-by: Alex Tereschenko <alext.mkrs@gmail.com>
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
Alex Tereschenko
2015-11-17 21:19:31 +01:00
committed by Brendan Le Foll
parent fa772a0a9d
commit 90accf7b04

View File

@@ -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 <your install prefix, e.g. /usr>/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