diff options
Diffstat (limited to 'release_docs/USING_CMake_Examples.txt')
| -rw-r--r-- | release_docs/USING_CMake_Examples.txt | 45 |
1 files changed, 19 insertions, 26 deletions
diff --git a/release_docs/USING_CMake_Examples.txt b/release_docs/USING_CMake_Examples.txt index 0956ff1..d52a719 100644 --- a/release_docs/USING_CMake_Examples.txt +++ b/release_docs/USING_CMake_Examples.txt @@ -2,39 +2,34 @@ * Build and Test HDF5 Examples with CMake * ************************************************************************ -Notes: This short instruction is written for users who want to quickly +Notes: This short instruction is written for users who want to quickly test the installation of HDF5 by using the CMake tools to build and test the HDF5 Examples. The following instructions will show the default usage and then present common changes for non-default installations. For more information, see the USING_HDF5_CMake.txt file. - - More information about using CMake can be found at the KitWare + + More information about using CMake can be found at the KitWare site, www.cmake.org. - + CMake uses the command line and these instructions use the script method of the ctest command. ======================================================================== -I. Preconditions +I. Preconditions ======================================================================== 1. We suggest you obtain the latest CMake for windows from the Kitware - web site. The HDF5 1.8.x product requires a minimum CMake version - of 3.1.0. - - 2. You have installed the HDF5 library built with CMake, by executing - the HDF Install Utility (the *.exe file in the binary package for - Windows or the *.sh on Linux). If you are using a Windows platform, - you can obtain a pre-built Windows binary from The HDF Group's website - at www.hdfgroup.org. See Section "III. Common changes to the + web site. The HDF5 1.8.x product requires a minimum CMake version + of 3.1.0. + + 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 or the *.sh on Linux). If you are using a Windows platform, + you can obtain a pre-built Windows binary from The HDF Group's website + at www.hdfgroup.org. See Section "III. Common changes to the HDF518_Examples.cmake file", for the line to change the location. - - 3. On Windows, you have installed the 7Zip package. See Section "III. - Common changes to the HDF518_Examples.cmake file", for the line to - change the command. - ======================================================================== @@ -42,16 +37,16 @@ II. Building HDF5 Examples with CMake ======================================================================== Files in the HDF5 install directory: - HDF5Examples-0.1.1-Source.zip (or HDF5Examples-0.1.1-Source.tar.gz) + HDF5Examples-0.1.1-Source folder HDF518_Examples.cmake - + Default installation process: Create a directory to run the examples, i.e. \test_hdf5. - Copy HDF5Examples-0.1.1-Source.zip(.tar.gz) to this directory, uncompress. + Copy HDF5Examples-0.1.1-Source folder to this directory. Copy HDF518_Examples.cmake to this directory. - Edit line 8 of the HDF518_Examples.cmake file and change the INSTALLDIR + Edit line 8 of the HDF518_Examples.cmake file and change the INSTALLDIR to the HDF5 install location. - + Execute from this directory: ctest -S HDF518_Examples.cmake,HDF5Examples-0.1.1-Source -C Release -O test.log @@ -60,7 +55,7 @@ The script will use the examples folder HDF5Examples-0.1.1-Source, It will then configure, build, and execute the examples. All the log files will be found under the build\Testing\Temporary directory, check these for errors. - + The amount of script information can be increased by adding -V to the ctest command. Even more information can be shown by adding -VV instead of -V. @@ -79,5 +74,3 @@ Line 16: comment to NOT build and test Fortran examples with F2003 option. Line 17: uncomment to use a compressed source file. -Line 71: change the CTEST_7Z_COMMAND to a different unzip program. - |