add CMAKE_INSTALL_PREFIX in README

NCAR · Apr 2, 2024 · d87bdd0 · d87bdd0
1 parent f05b93c
commit d87bdd0
Showing 1 changed file with 9 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -25,14 +25,15 @@ SPERR requires 1) a working C++ compiler and 2) CMake tools to build. On a Unix-
 the build steps are the following:
 
 ```bash
-git clone https://github.com/NCAR/SPERR.git # clone the repo
-mkdir SPERR/build                           # create the build directory
-cd SPERR/build                              # enter the build directory
-cmake ..                                    # Linux: use cmake to configure the project (with OpenMP)
-cmake -DUSE_OMP=OFF ..                      # Mac: use cmake to configure the project (OpenMP disabled)
-make -j 8                                   # build the project
-ctest .                                     # run unit tests, which should have 100% tests passed
-make install                                # install the library and CLI tools to a designated directory.
+git clone https://github.com/NCAR/SPERR.git     # clone the repo
+mkdir SPERR/build                               # create the build directory
+cd SPERR/build                                  # enter the build directory
+cmake ..                                        # Linux: use cmake to configure the project (with OpenMP)
+cmake -DUSE_OMP=OFF ..                          # Mac: use cmake to configure the project (OpenMP disabled)
+cmake -DCMAKE_INSTALL_PREFIX=/my/install/dir .. # Optional: specify a directory to install SPERR. The default is /usr/local .
+make -j 8                                       # build the project
+ctest .                                         # run unit tests, which should have 100% tests passed
+make install                                    # install the library and CLI tools to a specified directory.
 ```
 
 ## Plugin for HDF5