summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--MANIFEST1
-rwxr-xr-xconfigure2
-rw-r--r--examples/Makefile.am1
-rw-r--r--examples/Makefile.in3
-rw-r--r--examples/README17
5 files changed, 22 insertions, 2 deletions
diff --git a/MANIFEST b/MANIFEST
index 2432062..3041eec 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -132,6 +132,7 @@
./examples/h5_shared_mesg.c
./examples/ph5example.c
./examples/testh5cc.sh.in
+./examples/README
diff --git a/configure b/configure
index d119281..1df7aef 100755
--- a/configure
+++ b/configure
@@ -1,5 +1,5 @@
#! /bin/sh
-# From configure.in Id: configure.in 22267 2012-04-09 19:36:07Z mamcgree .
+# From configure.in Id: configure.in 22270 2012-04-09 19:54:57Z mamcgree .
# Guess values for system-dependent variables and create Makefiles.
# Generated by GNU Autoconf 2.68 for HDF5 1.8.9-pre1.
#
diff --git a/examples/Makefile.am b/examples/Makefile.am
index 9ec6a85..a35d8ca 100644
--- a/examples/Makefile.am
+++ b/examples/Makefile.am
@@ -44,6 +44,7 @@ INSTALL_FILES = h5_write.c h5_read.c h5_extend_write.c h5_chunk_read.c \
INSTALL_SCRIPT_FILES = run-c-ex.sh
INSTALL_TOP_SCRIPT_FILES = run-all-ex.sh
+INSTALL_TOP_FILES = README
# How to build examples, using installed version of h5cc
if BUILD_PARALLEL_CONDITIONAL
diff --git a/examples/Makefile.in b/examples/Makefile.in
index 597e6de..774fea1 100644
--- a/examples/Makefile.in
+++ b/examples/Makefile.in
@@ -54,7 +54,7 @@ PRE_UNINSTALL = :
POST_UNINSTALL = :
build_triplet = @build@
host_triplet = @host@
-DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in \
+DIST_COMMON = README $(srcdir)/Makefile.am $(srcdir)/Makefile.in \
$(srcdir)/run-c-ex.sh.in $(srcdir)/testh5cc.sh.in \
$(top_srcdir)/config/commence.am \
$(top_srcdir)/config/conclude.am \
@@ -382,6 +382,7 @@ INSTALL_FILES = h5_write.c h5_read.c h5_extend_write.c h5_chunk_read.c \
INSTALL_SCRIPT_FILES = run-c-ex.sh
INSTALL_TOP_SCRIPT_FILES = run-all-ex.sh
+INSTALL_TOP_FILES = README
# The external link examples demonstrate how to use paths; they need
# directories to be created to do this.
diff --git a/examples/README b/examples/README
new file mode 100644
index 0000000..0550b15
--- /dev/null
+++ b/examples/README
@@ -0,0 +1,17 @@
+ HDF5 Examples
+
+This directory contains example programs for the installed APIs and scripts to
+compile and run them. Examples in the c and hl/c subdirectories are always
+installed, and those in fortan, hl/fortran, c++ and hl/c++ will be installed
+when fortran or c++ are enabled.
+
+Running the run-all-ex.sh script in this directory will run the scripts and in
+turn the examples in all the subdirectories where examples are installed. The
+scripts can also be run individually. The appropriate compile scripts in the
+bin directory for this install will be used by default to compile and link the
+example programs. Note that h5redeploy must be run if these binaries are
+copied or extracted in a directory other than the one where they were initially
+installed. Compile scripts from other locations can be used by setting an
+environment variable prefix to the path of the directory containing the bin
+directory with the compile scripts h5cc, h5fc, etc. For example, export
+prefix=/usr/local/hdf5 to use h5cc, h5fc, etc. in /usr/local/hdf5/bin.