detectors/slsDetectorPackage
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2025-04-25 07:40:03 +02:00
Code Issues Actions Packages Releases Activity

Update README.md

Browse Source
This commit is contained in:
Dhanya Thattil 2020-03-03 17:55:16 +01:00 committed by GitHub
parent 9699e064d3
commit 582a3c6878
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@ -39,44 +39,27 @@ cmk.sh or directly with cmake for more control.
After compiling, the libraries and executables will be found in `slsDetectorPackage/build/bin` directory<br> After compiling, the libraries and executables will be found in `slsDetectorPackage/build/bin` directory<br>
Usage: [-c] [-b] [-h] [-d HDF5 directory] [-j]<br> Usage: [-c] [-b] [-p] [e] [t] [r] [g] [s] [u] [i] [-h] [-d <HDF5 directory>] [-j] <Number of threads>
* -[no option]: only make<br> -[no option]: only make
* -c: Clean<br> -c: Clean
* -b: Builds/Rebuilds CMake files normal mode<br> -b: Builds/Rebuilds CMake files normal mode
* -h: Builds/Rebuilds Cmake files with HDF5 package<br> -p: Builds/Rebuilds Python API
* -d: HDF5 Custom Directory<br> -h: Builds/Rebuilds Cmake files with HDF5 package
* -t: Build/Rebuilds only text client<br> -d: HDF5 Custom Directory
* -r: Build/Rebuilds only receiver<br> -t: Build/Rebuilds only text client
* -g: Build/Rebuilds only gui<br> -r: Build/Rebuilds only receiver
* -j: Number of threads to compile through<br> -g: Build/Rebuilds only gui
* -e: Debug mode -s: Simulator
-u: Chip Test Gui
Basic Option: -j: Number of threads to compile through
./cmk.sh -b -e: Debug mode
-i: Builds tests
For only make:
./cmk.sh
For make clean;make:
./cmk.sh -c
For using hdf5 without custom dir /blabla:
./cmk.sh -h -d /blabla
For rebuilding cmake without hdf5
./cmk.sh -b
For using multiple cores to compile faster:
./cmk.sh -j9<br>
For rebuilding only certain sections<br>
./cmk.sh -tg #only text client and gui<br>
./cmk.sh -r #only receiver<br>
eg. Rebuild when you switch to a new build and compile in parallel:
./cmk.sh -bj5
**2. Compile without script**<br> **2. Compile without script**<br>
Use cmake to create out-of-source builds, by creating a build folder parallel to source directory. This would crete a debug build with address sanitizers. Use cmake to create out-of-source builds, by creating a build folder parallel to source directory. This would create a debug build with address sanitizers.
``` ```
$ mkdir build $ mkdir build
$ cd build $ cd build