diff options
author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2022-02-02 19:45:59 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-02-02 19:45:59 (GMT) |
commit | 1d598182d6097052060f15a6b0d744c42a2fd80a (patch) | |
tree | 84982b93d0373809b55dd84a2855ae8b8df799fa /release_docs/USING_HDF5_CMake.txt | |
parent | 86ef00fd67d4f5007ff8e3390631009ad75891a5 (diff) | |
download | hdf5-1d598182d6097052060f15a6b0d744c42a2fd80a.zip hdf5-1d598182d6097052060f15a6b0d744c42a2fd80a.tar.gz hdf5-1d598182d6097052060f15a6b0d744c42a2fd80a.tar.bz2 |
Update doc with HDF5_ROOT usage. (#1414)
Diffstat (limited to 'release_docs/USING_HDF5_CMake.txt')
-rw-r--r-- | release_docs/USING_HDF5_CMake.txt | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/release_docs/USING_HDF5_CMake.txt b/release_docs/USING_HDF5_CMake.txt index 792c719..abe1906 100644 --- a/release_docs/USING_HDF5_CMake.txt +++ b/release_docs/USING_HDF5_CMake.txt @@ -29,27 +29,30 @@ Notes: This short instruction is written for users who want to quickly of using a ctest script for building and testing. See INSTALL_CMake.txt for more information. + 4. See https://cmake.org/cmake/help/latest/command/find_package.html + for more information on the CMake "Config Mode Search Procedure". ======================================================================== I. Preconditions ======================================================================== - 1. We suggest you obtain the latest CMake for windows from the Kitware + 1. We suggest you obtain the latest CMake for your platform from the Kitware web site. The HDF5 1.13.x product requires a minimum CMake version - of 3.12. + of 3.12. If you are using VS2019, the minimum version is 3.15. 2. You have installed the HDF5 library built with CMake, by executing the HDF Install Utility (the *.msi file in the binary package for - Windows). You can obtain pre-built binaries from The HDF Group's website at - www.hdfgroup.org. + Windows or the *.sh on Linux). You can obtain pre-built binaries + from The HDF Group's website at www.hdfgroup.org. - 3. Set the environment variable HDF5_DIR to the installed location of - the config files for HDF5. + 3. Set the HDF5_ROOT CMake variable, -DHDF5_ROOT=<install_path> + or environment variable, set(ENV{HDF5_ROOT} "<install_path>") + to the installed location of HDF5. On Windows: - HDF5_DIR=C:/Program Files/HDF_Group/HDF5/1.13.x/cmake + HDF5_ROOT=C:/Program Files/HDF_Group/HDF5/1.13.x/ On unix: - HDF5_DIR=<install root folder>/HDF_Group/HDF5/1.13.x/cmake + HDF5_ROOT=<install root folder>/HDF_Group/HDF5/1.13.x/ If you are using shared libraries, you may need to add to the path environment variable. Set the path environment variable to the |