From 59d8584a9ef01af0dd545f3929b2359f1f28b92d Mon Sep 17 00:00:00 2001 From: wang_x1 Date: Thu, 1 Sep 2016 11:16:17 +0200 Subject: [PATCH] README for compilation --- README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..c1fd43678 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# slsDetector package + + +## Installation + +### Get source +The source code is organised into several submodules, and the top level module is +sls_detectors_package. + +``` + $ git clone git@git.psi.ch:sls_detectors_software/sls_detectors_package.git + $ cd sls_detectors_package + $ ./checkout.sh +``` + +### Setup dependencies +The GUI client requires Qt 4.8 and Qwt 6.0 +``` + export QTDIR=/usr/local/Trolltech/ + export QWTDIR=/usr/local/qwt-6.0.1/ +``` +If either of them does not exist, the GUI client will not be built. + +The calibration wizards require ROOT +``` + export ROOTSYS=/usr/local/root-5.34 +``` + +### Compile +Use cmake to create out-of-source builds, by creating an build folder parallel to source directory. +``` + $ cd .. + $ mkdir sls_detectors_package-build + $ cd sls_detectors_package-build + $ cmake ../sls_detectors_package + $ make +``` + +The libraries and executables will be found at `bin` directory +``` + $ ls bin/ + gui_client libSlsDetector.a libSlsDetector.so libSlsReceiver.a libSlsReceiver.so + sls_detector_acquire sls_detector_get slsDetectorGui sls_detector_help sls_detector_put slsReceiver +```