From 7b81532f547402861d491ec7904e094a7c87030f Mon Sep 17 00:00:00 2001 From: Dhanya Thattil Date: Wed, 18 Nov 2020 17:27:34 +0100 Subject: [PATCH] update doc --- docs/src/installation.rst | 39 ++++++++++++++++++++++++--------------- 1 file changed, 24 insertions(+), 15 deletions(-) diff --git a/docs/src/installation.rst b/docs/src/installation.rst index e7de88f5d..dfcbf4b10 100644 --- a/docs/src/installation.rst +++ b/docs/src/installation.rst @@ -55,24 +55,33 @@ These are mainly aimed at those not familiar with using ccmake and cmake. The binaries are generated in slsDetectorPackage/build/bin directory. - # new build and make with 9 parallel threads - ./cmk.sh -cbj9 - - # build with python - ./cmk.sh -bpj9 - - # build with GUI - ./cmk.sh -bgj9 - - # build with hdf5 - ./cmk.sh -hj9 -d [path of hdf5 dir] - - # build and install binaries - ./cmk.sh -bl [path to install] - + Usage: $0 [-c] [-b] [-p] [e] [t] [r] [g] [s] [u] [i] [m] [n] [-h] [z] [-d ] [-l Install directory] [-k ] [-j ] + -[no option]: only make + -c: Clean + -b: Builds/Rebuilds CMake files normal mode + -p: Builds/Rebuilds Python API + -h: Builds/Rebuilds Cmake files with HDF5 package + -d: HDF5 Custom Directory + -k: CMake command + -l: Install directory + -t: Build/Rebuilds only text client + -r: Build/Rebuilds only receiver + -g: Build/Rebuilds only gui + -s: Simulator + -u: Chip Test Gui + -j: Number of threads to compile through + -e: Debug mode + -i: Builds tests + -m: Manuals + -n: Manuals without compiling doxygen (only rst) + -z: Moench zmq processor + # get all options ./cmk.sh -? + # new build and compile in parallel: + ./cmk.sh -bj5 + Install binaries using conda --------------------------------