From 582a3c6878470b6fe2aced448723d62dcb0838b8 Mon Sep 17 00:00:00 2001
From: Dhanya Thattil <33750417+thattil@users.noreply.github.com>
Date: Tue, 3 Mar 2020 17:55:16 +0100
Subject: [PATCH] Update README.md
---
README.md | 55 +++++++++++++++++++------------------------------------
1 file changed, 19 insertions(+), 36 deletions(-)
diff --git a/README.md b/README.md
index c15bfa4b0..98d313540 100755
--- a/README.md
+++ b/README.md
@@ -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
-Usage: [-c] [-b] [-h] [-d HDF5 directory] [-j]
- * -[no option]: only make
- * -c: Clean
- * -b: Builds/Rebuilds CMake files normal mode
- * -h: Builds/Rebuilds Cmake files with HDF5 package
- * -d: HDF5 Custom Directory
- * -t: Build/Rebuilds only text client
- * -r: Build/Rebuilds only receiver
- * -g: Build/Rebuilds only gui
- * -j: Number of threads to compile through
- * -e: Debug mode
-
-Basic Option:
-./cmk.sh -b
-
-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
-
-
-For rebuilding only certain sections
-./cmk.sh -tg #only text client and gui
-./cmk.sh -r #only receiver
-
+Usage: [-c] [-b] [-p] [e] [t] [r] [g] [s] [u] [i] [-h] [-d ] [-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
+ -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
+
+eg. Rebuild when you switch to a new build and compile in parallel:
+./cmk.sh -bj5
**2. Compile without script**
-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
$ cd build