diff options
| author | Allen Byrne <byrn@hdfgroup.org> | 2014-02-13 14:00:00 (GMT) |
|---|---|---|
| committer | Allen Byrne <byrn@hdfgroup.org> | 2014-02-13 14:00:00 (GMT) |
| commit | 82f62cd0129656a8672bb6b772eded30130f7fba (patch) | |
| tree | 3c3e5c02840425d37ea37e6422a1a8a58f33ae0e /config/cmake/README.txt.cmake.in | |
| parent | ab045c634cac0219939b93a1d2b829e7b1f3e7a1 (diff) | |
| download | hdf5-82f62cd0129656a8672bb6b772eded30130f7fba.zip hdf5-82f62cd0129656a8672bb6b772eded30130f7fba.tar.gz hdf5-82f62cd0129656a8672bb6b772eded30130f7fba.tar.bz2 | |
[svn-r24703] Add Binary README.txt file generation
Tested: local linux cmake
Diffstat (limited to 'config/cmake/README.txt.cmake.in')
| -rwxr-xr-x | config/cmake/README.txt.cmake.in | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/config/cmake/README.txt.cmake.in b/config/cmake/README.txt.cmake.in new file mode 100755 index 0000000..5e1f65a --- /dev/null +++ b/config/cmake/README.txt.cmake.in @@ -0,0 +1,44 @@ +@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
+
+The compressed examples file HDF5Examples-0.1.1-Source.@BINARY_EXAMPLE_ENDING@, 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.
+
+To test the installation with the examples;
+ Create a directory to run the examples.
+ Copy HDF5Examples-0.1.1-Source.@BINARY_EXAMPLE_ENDING@ to this directory, do NOT unzip.
+ Copy HDF518_Examples.cmake to this directory.
+ Edit HDF518_Examples.cmake line 8 to set INSTALLDIR to where HDF5 is installed.
+ Execute from this directory:
+ ctest -S HDF518_Examples.cmake,HDF5Examples-0.1.1-Source -C Release -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.
+
+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.
|