mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-04-25 15:50:03 +02:00
update doc
This commit is contained in:
parent
77dacdf40d
commit
e39ea64560
36
README.md
36
README.md
@ -43,28 +43,24 @@ cmk.sh or directly with cmake for more control.
|
|||||||
**1. Compile using script cmk.sh**<br>
|
**1. Compile using script cmk.sh**<br>
|
||||||
|
|
||||||
These are mainly aimed at those not familiar with using ccmake and cmake. After compiling, the libraries and executables will be found in `slsDetectorPackage/build/bin` directory<br>
|
These are mainly aimed at those not familiar with using ccmake and cmake. After compiling, the libraries and executables will be found in `slsDetectorPackage/build/bin` directory<br>
|
||||||
|
```
|
||||||
|
The binaries are generated in slsDetectorPackage/build/bin directory.
|
||||||
|
|
||||||
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>]
|
# new build and make with 9 parallel threads
|
||||||
-[no option]: only make
|
./cmk.sh -cbj9
|
||||||
-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
|
|
||||||
|
|
||||||
|
# build with python
|
||||||
|
./cmk.sh -bpj9
|
||||||
|
|
||||||
|
# build with GUI
|
||||||
|
./cmk.sh -bgj9
|
||||||
|
|
||||||
|
# build with hdf5
|
||||||
|
./cmk.sh -hj9 -d [path of hdf5 dir]
|
||||||
|
|
||||||
|
# get all options
|
||||||
|
./cmk.sh -?
|
||||||
|
```
|
||||||
|
|
||||||
eg. Rebuild when you switch to a new build and compile in parallel:
|
eg. Rebuild when you switch to a new build and compile in parallel:
|
||||||
./cmk.sh -bj5
|
./cmk.sh -bj5
|
||||||
|
@ -117,8 +117,8 @@ SLS Detector Package 5.0.0 released on 18.11.2020 (Major Release)
|
|||||||
eg. daclist, settingslist, drlist, timinglist, templist
|
eg. daclist, settingslist, drlist, timinglist, templist
|
||||||
Command line also has commands to get their values.
|
Command line also has commands to get their values.
|
||||||
eg. dacvalues, tempvalues
|
eg. dacvalues, tempvalues
|
||||||
Python has commands to get their values.
|
Python has commands to get their values (detector specific class).
|
||||||
eg. ???????????
|
eg. d.temp, d.dacs
|
||||||
|
|
||||||
8. Command Line (return code)
|
8. Command Line (return code)
|
||||||
Return code of the client command line applications now return 0 for
|
Return code of the client command line applications now return 0 for
|
||||||
|
Loading…
x
Reference in New Issue
Block a user