update doc

This commit is contained in:
maliakal_d 2020-11-18 17:27:34 +01:00
parent dcf0b58a6d
commit 7b81532f54

View File

@ -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. The binaries are generated in slsDetectorPackage/build/bin directory.
# new build and make with 9 parallel threads Usage: $0 [-c] [-b] [-p] [e] [t] [r] [g] [s] [u] [i] [m] [n] [-h] [z] [-d <HDF5 directory>] [-l Install directory] [-k <CMake command>] [-j <Number of threads>]
./cmk.sh -cbj9 -[no option]: only make
-c: Clean
# build with python -b: Builds/Rebuilds CMake files normal mode
./cmk.sh -bpj9 -p: Builds/Rebuilds Python API
-h: Builds/Rebuilds Cmake files with HDF5 package
# build with GUI -d: HDF5 Custom Directory
./cmk.sh -bgj9 -k: CMake command
-l: Install directory
# build with hdf5 -t: Build/Rebuilds only text client
./cmk.sh -hj9 -d [path of hdf5 dir] -r: Build/Rebuilds only receiver
-g: Build/Rebuilds only gui
# build and install binaries -s: Simulator
./cmk.sh -bl [path to install] -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 # get all options
./cmk.sh -? ./cmk.sh -?
# new build and compile in parallel:
./cmk.sh -bj5
Install binaries using conda Install binaries using conda
-------------------------------- --------------------------------