1@HDF5_PACKAGE_NAME@ version @HDF5_PACKAGE_VERSION_STRING@
2------------------------------------------------------------------------------
3
4This directory contains the binary (release) distribution of
5@HDF5_PACKAGE_NAME@ @HDF5_PACKAGE_VERSION_MAJOR@ that was compiled on;
6    @BINARY_PLATFORM@.
7
8It was built with the following options:
9    -- @LIB_TYPE@ C/C++/Fortran libraries
10    -- SZIP (encoder enabled) and ZLIB
11    -- @LIB_TYPE@ HDF5 tools
12
13The contents of this directory are:
14
15    COPYING                 - Copyright notice
16    README.txt              - This file
17    @HDF5_PACKAGE_NAME@-@HDF5_PACKAGE_VERSION@-@BINARY_SYSTEM_NAME@.@BINARY_INSTALL_ENDING@    - HDF5 Install Package
18
19Installation
20===========================================================================
211. Execute @HDF5_PACKAGE_NAME@-@HDF5_PACKAGE_VERSION@-@BINARY_SYSTEM_NAME@.@BINARY_INSTALL_ENDING@
222. Follow prompts
23===========================================================================
24
25After Installation
26===========================================================================
27The examples folder, HDF5Examples, located in the
28HDF5 install folder, can be built and tested with CMake and the supplied
29HDF518_Examples.cmake file. The HDF518_Examples.cmake expects HDF5 to have
30been installed in the default location with above compilers. Also, the CMake
31utility should be installed.
32
33To test the installation with the examples;
34    Create a directory to run the examples.
35    Copy HDF5Examples folder to this directory.
36    Copy HDF518_Examples.cmake to this directory.
37    Copy HDF5_Examples_options.cmake to this directory.
38    Copy CTestScript.cmake to this directory.
39    The default source folder is defined as "HDF5Examples". It can be changed
40        with the CTEST_SOURCE_NAME script option.
41    The default installation folder is defined as "@CMAKE_INSTALL_PREFIX@".
42        It can be changed with the INSTALLDIR script option.
43    The default ctest configuration is defined as "Release". It can be changed
44        with the CTEST_CONFIGURATION_TYPE script option. Note that this must
45        be the same as the value used with the -C command line option.
46    The default build configuration is defined to build and use static libraries.
47        Shared libraries can be used with the STATICONLYLIBRARIES script option set to "NO".
48    Other options can be changed by editing the HDF518_Examples_options.cmake file.
49
50    If the defaults are okay, execute from this directory:
51        ctest -S HDF518_Examples.cmake -C Release -V -O test.log
52    If the defaults need change, execute from this directory:
53        ctest -S HDF518_Examples.cmake,CTEST_SOURCE_NAME=MyExamples,INSTALLDIR=MyLocation -C Release -V -O test.log
54
55When executed, the ctest script will save the results to the log file, test.log, as
56indicated by the ctest command. If you wish the to see more build and test information,
57add "-VV" to the ctest command. The output should show;
58      100% tests passed, 0 tests failed out of 156.
59
60For more information see USING_CMake_Examples.txt in the install folder.
61===========================================================================
62
63Documentation for this release can be found at the following URL:
64    http://www.hdfgroup.org/HDF5/doc/.
65
66See the HDF5 home page for further details:
67    http://hdfgroup.org/HDF5/
68
69Bugs should be reported to help@hdfgroup.org.
70