summaryrefslogtreecommitdiffstats
path: root/config/cmake/README.txt.cmake.in
blob: 79482bd711ed22dbb94a18e7ccb906be50109573 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
@HDF5_PACKAGE_NAME@ version @HDF5_PACKAGE_VERSION_STRING@
------------------------------------------------------------------------------

This directory contains the binary (release) distribution of 
@HDF5_PACKAGE_NAME@ @HDF5_PACKAGE_VERSION_MAJOR@ that was compiled on;
    @BINARY_PLATFORM@. 

It was built with the following options: 
    -- @LIB_TYPE@ C/C++/Fortran libraries
    -- SZIP (encoder enabled) and ZLIB
    -- @LIB_TYPE@ HDF5 tools

The contents of this directory are:

    COPYING                 - Copyright notice
    README.txt              - This file
    @HDF5_PACKAGE_NAME@-@HDF5_PACKAGE_VERSION@-@BINARY_SYSTEM_NAME@.@BINARY_INSTALL_ENDING@    - HDF5 Install Package

Installation
===========================================================================
1. Execute @HDF5_PACKAGE_NAME@-@HDF5_PACKAGE_VERSION@-@BINARY_SYSTEM_NAME@.@BINARY_INSTALL_ENDING@
2. Follow prompts
===========================================================================

After Installation
===========================================================================
The examples folder, HDF5Examples-0.1.1-Source, located in the 
HDF5 install folder, can be built and tested with CMake and the supplied
HDF518_Examples.cmake file. The HDF518_Examples.cmake expects HDF5 to have
been installed in the default location with above compilers. Also, the CMake 
utility should be installed.

To test the installation with the examples;
    Create a directory to run the examples.
    Copy HDF5Examples-0.1.1-Source folder to this directory.
    Copy HDF518_Examples.cmake to this directory.
    Edit HDF518_Examples.cmake line 8 to set INSTALLDIR to where HDF5 is installed.
       (The default should be correct unless you installed into a different folder.)
    Execute from this directory: 
        ctest -S HDF518_Examples.cmake,HDF5Examples-0.1.1-Source -C Release -V -O test.log

When executed, the ctest script will save the results to the log file, test.log, as
indicated by the ctest command. If you wish the to see more build and test information, 
add "-VV" to the ctest command. The output should show;
      100% tests passed, 0 tests failed out of 156.

For more information see USING_CMake_Examples.txt in the install folder. 
===========================================================================

Documentation for this release can be found at the following URL:
    http://www.hdfgroup.org/HDF5/doc/.

See the HDF5 home page for further details:
    http://hdfgroup.org/HDF5/

Bugs should be reported to help@hdfgroup.org.