Updates to README's

AcademySoftwareFoundation · Aug 8, 2018 · 0690e76 · 0690e76
1 parent 4a74696
commit 0690e76
Show file tree

Hide file tree

Showing 3 changed files with 72 additions and 62 deletions.
diff --git a/IlmBase/README.md b/IlmBase/README.md
@@ -33,18 +33,7 @@ for the legal fine print.
 Building and Installation
 -------------------------
 
-You can build IlmBase using either **autoconf** or **cmake**.
-
-#### Building with **autoconf**
-
-First, ensure that **autoconf** is installed.  Download and install it
-from https://www.gnu.org/software/autoconf/autoconf.html.
-
-To bootstrap the build process:
-
-    ./bootstrap
-
-To create Makefiles via **autoconf**:
+To configure the Makefiles, run the ``configure`` script:
 
     ./configure
 
@@ -56,19 +45,20 @@ In particular, the ``--prefix=<install directory>`` option specifies a
 directory into which to install the headers and libraries. By default,
 headers and libraries are installed into ``/usr/local``.
 
-To build the libraries:
+To build the libraries after running ``configure``:
 
     make
     make install
 
-#### Building with **cmake**
-
-First, ensure that **cmake** is installed. Download and install it
-from https://cmake.org/download.
+#### Building from Git
 
-To bootstrap the **cmake** build process:
+If building directly from a cloned git repo, first generate the
+configuration scripts by running ``bootstrap``, then ``configure`` and
+``make``:
 
-    cmake -DCMAKE_INSTALL_PREFIX=<install directory> <IlmBase source directory>
+    cd <source root>/IlmBase
+    ./bootstrap
+    ./configure
     make
     make install
 

diff --git a/OpenEXR/README.md b/OpenEXR/README.md
@@ -43,18 +43,7 @@ Building OpenEXR requires IlmBase and the [zlib](https://zlib.net) library.
 Building and Installation
 -------------------------
 
-You can build OpenEXR using either **autoconf** or **cmake**.
-
-#### Building with **autoconf**
-
-First, ensure that **autoconf** is installed.  Download and install it
-from https://www.gnu.org/software/autoconf/autoconf.html.
-
-To bootstrap the build process:
-
-    ./bootstrap
-
-To create Makefiles via **autoconf**:
+To configure the Makefiles, run the ``configure`` script:
 
     ./configure
 
@@ -74,19 +63,18 @@ In particular, arguments of note include:
 
 * ``--enable-imfexamples`` - build IlmImf example program.
 
-To build the libraries:
+See the Test section below for options to enable time-consuming
+confidence tests.
 
-    make
-    make install
-
-#### Building with **cmake**
+#### Building from Git
 
-First, ensure that **cmake** is installed. Download and install it
-from https://cmake.org/download.
+If building directly from a cloned git repo, first generate the
+configuration scripts by running ``bootstrap``, then ``configure`` and
+``make``:
 
-To bootstrap the **cmake** build process:
-
-    cmake -DCMAKE_INSTALL_PREFIX=<install directory> <OpenEXR source directory>
+    cd <source root>/IlmBase
+    ./bootstrap
+    ./configure
     make
     make install
 

diff --git a/README.md b/README.md
@@ -62,6 +62,18 @@ Please see the ``README`` files of each of the individual directories for more i
 A collection of OpenEXR images is available from the adjacent repository
 [openexr-images](https://github.com/openexr/openexr-images).
 
+Dependencies
+------------
+
+OpenEXR depends on [zlib](https://zlib.net).
+
+PyIlmBase depends on [boost-python](https://github.com/boostorg/python).
+
+In OpenEXR_Viewers:
+
+* **exrdisplay** depends on [fltk](http://www.fltk.org/index.php)
+* **playexr** depends on [Cg](https://developer.nvidia.com/cg-toolkit)
+
 Web Resources
 -------------
 
@@ -83,47 +95,67 @@ Building and Installation
 Download the latest release of OpenEXR from
 http://www.openexr.com/downloads.html.
 
-Alternatively, you can download the latest release or the lastest
-development branch directly from http://github.com/openexr.
-
 To build the OpenEXR binaries from source, compile and install the
 individual sub-models (IlmBase, PyIlmBase, OpenEXR, OpenEXR_Viewers),
-according to the instructions in the respective ``README`` files.
+according to the instructions in the respective ``README``
+files. Build and install the IlmBase module first, then build and
+install the OpenEXR module. Optionally, then build and install
+PyIlmBase, OpenEXR_Viewers, and Contrib.
 
-Build and install the IlmBase module first, then build and install the
-OpenEXR module. Optionally, then build and install PyIlmBase,
-OpenEXR_Viewers, and Contrib.
+For the basic installation:
 
-The build system supports building via autoconf or cmake. See in
-``README`` files in the IlmBase, PyIlmBase, OpenEXR, and OpenEXR_Viewers
-directories for specific instructions.
+    cd <source root>/IlmBase
+    ./configure
+    make
+    make install
 
-#### Dependencies
+    cd <source root>/OpenEXR
+    ./configure
+    make 
+    make install
 
-OpenEXR depends on [zlib](https://zlib.net).
+See the module ``README`` files for options to ``configure``.
 
-PyIlmBase depends on [boost-python](https://github.com/boostorg/python).
+#### Building from Git
 
-In OpenEXR_Viewers:
+Alternatively, you can download the latest release or the lastest
+development branch directly from http://github.com/openexr.
 
-* **exrdisplay** depends on [fltk](http://www.fltk.org/index.php)
-* **playexr** depends on [Cg](https://developer.nvidia.com/cg-toolkit)
+After cloning the repo locally, generate the configuration scripts by
+running the ``bootstrap`` script:
 
-#### Building with CMake
+    cd <source root>/IlmBase
+    ./bootstrap
+    ./configure
+    make
+    make install
 
-To build with **cmake** requires **cmake** version 3.11 or newer.
+    cd <source root>/OpenExr
+    ./bootstrap
+    ./configure
+    make
+    make install
+
+Building from git and ``bootstrap`` requires that **autoconf** is
+installed.  Download and install it from
+https://www.gnu.org/software/autoconf/autoconf.html.
+
+#### Building with CMake
 
-When these prerequisites are fulfulled, prepare the build environment.
+Alternatively, you can build with **cmake**, version 3.11 or newer. 
 
 In the root ``CMakeLists.txt`` file, or using a tools such as
 **ccmake** or **cmake-gui**, configure the OpenEXR build. The options
 are detailed below.
 
-Create a build directory, cd into it, and run **cmake** to configure
+Create a source root directory, cd into it, and run **cmake** to configure
 the build.  Select an appropriate generator, such as "Unix Makefiles",
-or "Visual Studio 15 2017 Win64".
+or "Visual Studio 15 2017 Win64". Then run **make** a the root
+directory; this will build the appropriate submodules, according to
+the settings of the **cmake** options, described below.
 
     cmake -DCMAKE_INSTALL_PREFIX=<install location> <OpenEXR source root> -G "selected generator" -DCMAKE_PREFIX_PATH=<paths to dependencies - zlib etc>
+    make
 
 The available options are: