From e39ea64560f8d49b7b800fe2890396ad87a2383b Mon Sep 17 00:00:00 2001
From: Dhanya Thattil <dhanya.thattil@psi.ch>
Date: Wed, 18 Nov 2020 17:10:43 +0100
Subject: [PATCH] update doc

---
 README.md   | 36 ++++++++++++++++--------------------
 RELEASE.txt |  4 ++--
 cmk.sh      |  2 +-
 3 files changed, 19 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index 46a46b741..caaaf6ef3 100755
--- a/README.md
+++ b/README.md
@@ -43,28 +43,24 @@ cmk.sh or directly with cmake for more control.
 **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>
+```
+    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>]
- -[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
+    # 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]
+
+    # get all options
+    ./cmk.sh -?
+```
   
 eg. Rebuild when you switch to a new build and compile in parallel:
 ./cmk.sh -bj5
diff --git a/RELEASE.txt b/RELEASE.txt
index 3cced7357..978e38b8b 100755
--- a/RELEASE.txt
+++ b/RELEASE.txt
@@ -117,8 +117,8 @@ SLS Detector Package 5.0.0 released on 18.11.2020 (Major Release)
             eg. daclist, settingslist, drlist, timinglist, templist
         Command line also has commands to get their values.
             eg. dacvalues, tempvalues
-        Python has commands to get their values.
-            eg. ???????????
+        Python has commands to get their values (detector specific class).
+            eg. d.temp, d.dacs
 
     8.  Command Line (return code)
         Return code of the client command line applications now return 0 for 
diff --git a/cmk.sh b/cmk.sh
index ec718ffda..bceabc589 100755
--- a/cmk.sh
+++ b/cmk.sh
@@ -329,7 +329,7 @@ fi
 if [ -n "$INSTALLDIR" ]; then
 	make install
 #	popd
-#	cmake --build $BUILDDIR --target install
+#	$CMAKE --build $BUILDDIR --target install
 fi