diff --git a/README.md b/README.md index 0dcc5b18c..2c474e8b0 100755 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Please do not update to any xxxx.xx.xx.dev0 tags. They are not releases, but tag Use only releases with tags such as x.x.x or x.x.x-rcx. ### Documentation -Detailed documentation can be found on the [official site.](https://www.psi.ch/detectors/users-support) +Detailed documentation on the latest release of 5.0.0 can be found in the [software wiki.](https://slsdetectorgroup.github.io/devdoc/index.html) and on the [official site.](https://www.psi.ch/en/detectors/software) ### Binaries Binaries for the slsDetectorPackage are available through conda. @@ -42,15 +42,17 @@ cmk.sh or directly with cmake for more control. **1. Compile using script cmk.sh**
-After compiling, the libraries and executables will be found in `slsDetectorPackage/build/bin` directory
+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
-Usage: [-c] [-b] [-p] [e] [t] [r] [g] [s] [u] [i] [-h] [-d ] [-j] +Usage: $0 [-c] [-b] [-p] [e] [t] [r] [g] [s] [u] [i] [m] [n] [-h] [z] [-d ] [-l Install directory] [-k ] [-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 + -k: CMake command + -l: Install directory -t: Build/Rebuilds only text client -r: Build/Rebuilds only receiver -g: Build/Rebuilds only gui @@ -59,6 +61,10 @@ Usage: [-c] [-b] [-p] [e] [t] [r] [g] [s] [u] [i] [-h] [-d ] [-j -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 + eg. Rebuild when you switch to a new build and compile in parallel: ./cmk.sh -bj5 diff --git a/docs/src/installation.rst b/docs/src/installation.rst index 852088a0f..2d2d92f4d 100644 --- a/docs/src/installation.rst +++ b/docs/src/installation.rst @@ -50,6 +50,7 @@ The easiest way to configure options is to use the ccmake utility. Build using cmk.sh script ------------------------- These are mainly aimed at those not familiar with using ccmake and cmake. + .. code-block:: bash The binaries are generated in slsDetectorPackage/build/bin directory.