Update README, INSTALL, CONTRIBUTORS for 3.0
## Download
To build the latest release of OpenEXR, begin by downloading the
-source from the Releases page
-https://github.com/AcademySoftwareFoundation/openexr/tarball/v2.5.1.
+source from the GitHub Releases page:
+https://github.com/AcademySoftwareFoundation/releases.
To build from the latest development version, which may not be stable,
-download the master branch via
-https://github.com/AcademySoftwareFoundation/openexr/tarball/master, and extract the
-contents via ``tar``.
+clone the GitHub repo and build from the master branch:
-You can download the repository tarball file either via a browser, or
-on the Linux/macOS via the command line using ``wget`` or ``curl``:
+ % git clone https://github.com/AcademySoftwareFoundation/openexr
- % curl -L https://github.com/AcademySoftwareFoundation/openexr/tarball/master | tar xv
-
-This will produce a source directory named
-``openexr-openexr-<abbreviated-SHA-1-checksum>``.
+You can alternatively download the repository tarball file either via
+a browser, or on the Linux/macOS via the command line using ``wget``
+or ``curl``:
-Alternatively, clone the GitHub repo directly via:
-
- % git clone https://github.com/AcademySoftwareFoundation/openexr.git
+ % curl -L https://github.com/AcademySoftwareFoundation/openexr/tarball/master | tar xv
In the instructions that follow, we will refer to the top-level
directory of the source code tree as ``$source_directory``.
@@ -30,16 +24,15 @@ directory of the source code tree as ``$source_directory``.
Make sure these are installed on your system before building OpenEXR:
-* OpenEXR requires CMake version 3.10 or newer
- - NB: CMake 3.12 is required for configuring to build static and
- shared libraries in the same config (object library support)
+* OpenEXR requires CMake version 3.12 or newer
* C++ compiler that supports C++11
* Zlib (auto compiled if not found)
* Imath (auto compiled if not found)
-The instructions that follow describe building OpenEXR with CMake, but
-you can also build and install OpenEXR via the autoconf
-bootstrap/configure utilities, described below.
+The instructions that follow describe building OpenEXR with CMake.
+
+Note that as of OpenEXR 3, the Gnu autoconf bootstrap/configure build
+system is no longer supported.
## Linux/macOS Quick Start
@@ -78,6 +71,14 @@ can specify a local install directory to cmake via the
% cmake .. -DCMAKE_INSTALL_PREFIX=$install_directory
+## Porting Application from OpenEXR v2 to v3
+
+See the [porting
+guide](https://github.com/AcademySoftwareFoundation/Imath/blob/master/docs/PortingGuide2-3.md)
+for details about differences from previous releases and how to
+address them. Also refer to the porting guide for details about
+changes to Imath.
+
## Library Names
By default the installed libraries follow a pattern for how they are
