Skip to content

Commit

Permalink
README fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
@cary-ilm @nickrasmussen
cary-ilm authored and nickrasmussen committed Aug 8, 2018
1 parent cda04c6 commit c612d82
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 62 deletions.
55 changes: 24 additions & 31 deletions IlmBase/README.md
View file
@@ -1,13 +1,13 @@
The IlmBase Libraries
=====================

* **Half** is a class that encapsulates our 16-bit floating-point format.
* **Half** - a class that encapsulates our 16-bit floating-point format.

* **IlmThread** is a thread abstraction library for use with OpenEXR and
* **IlmThread** - a thread abstraction library for use with OpenEXR and
other software packages. It currently supports pthreads and Windows
threads.

* **Imath** implements 2D and 3D vectors, 3x3 and 4x4 matrices, quaternions
* **Imath** - 2D and 3D vectors, 3x3 and 4x4 matrices, quaternions
and other useful 2D and 3D math functions.

* **Iex** is an exception-handling library.
Expand All @@ -27,8 +27,7 @@ Building and Installation

You can build IlmBase using either **autoconf** or **cmake**.

Building with **autoconf**
~~~~~~~~~~~~~~~~~~~~~~~~~~
#### Building with **autoconf**

First, ensure that **autoconf** is instaleld. Download and install it
from https://www.gnu.org/software/autoconf/autoconf.html.
Expand All @@ -55,8 +54,7 @@ To build the libraries:
make install


Building with **cmake**
~~~~~~~~~~~~~~~~~~~~~~~
#### Building with **cmake**

First, ensure that **cmake** is installed. Download and install it
from https://cmake.org/download.
Expand All @@ -67,19 +65,18 @@ To bootstrap the cmake build process:
make
make install

Buildint on Windows using **cmake**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#### Building on Windows using **cmake**

To generate Visual Studio solution files and build the libraries:

1. Launch a command window, navigate to the IlmBase folder with
CMakeLists.txt,and type command:

setlocal
del /f CMakeCache.txt
cmake -DCMAKE_INSTALL_PREFIX=<where you want to install the ilmbase builds>
-G "Visual Studio 10 Win64"
..\ilmbase
setlocal
del /f CMakeCache.txt
cmake -DCMAKE_INSTALL_PREFIX=<where you want to install the ilmbase builds>
-G "Visual Studio 10 Win64"
..\ilmbase

2. Navigate to IlmBase folder in Windows Explorer, open ILMBase.sln
and build the solution. When it build successfully, right click
Expand All @@ -91,22 +88,21 @@ To generate Visual Studio solution files and build the libraries:
4. Launch a command window, navigate to the OpenEXR folder with
CMakeLists.txt, and type command:

setlocal
del /f CMakeCache.txt
cmake
-DZLIB_ROOT=<zlib location>
-DILMBASE_PACKAGE_PREFIX=<where you installed the ilmbase builds>
-DCMAKE_INSTALL_PREFIX=<where you want to instal the openexr builds>
-G "Visual Studio 10 Win64" ^
..\openexr
setlocal
del /f CMakeCache.txt
cmake
-DZLIB_ROOT=<zlib location>
-DILMBASE_PACKAGE_PREFIX=<where you installed the ilmbase builds>
-DCMAKE_INSTALL_PREFIX=<where you want to instal the openexr builds>
-G "Visual Studio 10 Win64" ^
..\openexr

5. Navigate to OpenEXR folder in Windows Explorer, open OpenEXR.sln
and build the solution. When it build successfully, right click
INSTALL project and build. It will install the output to the path
you set up at the previous step.

Building on **macOS**
~~~~~~~~~~~~~~~~~~~~~
#### Building on **macOS**

**macOS** supports multiple architectures. By default, IlmBase will be
built for the system doing the building. For example, if you build
Expand Down Expand Up @@ -136,8 +132,7 @@ available, but deprecated in favor of the more flexible
``--enable-osx-arch`` and ``--enable-osx-sdk`` switches.


Choosing an SDK on macOS
~~~~~~~~~~~~~~~~~~~~~~~~
#### Choosing an SDK on macOS

**macOS** allows you to specify one of several SDKs, or sysroots. This
allows you to target systems other than the system that your build
Expand Down Expand Up @@ -186,8 +181,7 @@ and

./configure --enable-customusernamespace

Internal Library Namespace
~~~~~~~~~~~~~~~~~~~~~~~~~~
#### Internal Library Namespace

The ``--enable-namespaceversioning`` option controls the namespace
that is used in the library. Without an argument (see below) the
Expand Down Expand Up @@ -243,8 +237,7 @@ These forward declarations should be removed, and replaced with:

which forward-declares all types correctly.

Public/User Library Namespace
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#### Public/User Library Namespace

The ``--enable-customusernamespace`` option can override the namespace
into which will the internal namespace will be exported. This takes an
Expand Down Expand Up @@ -272,7 +265,7 @@ the OpenEXR subdirectory of the install prefix,
e.g. ``/usr/local/include/OpenEXR``.


Uisng IlmBase in Your Applications
Using IlmBase in Your Applications
----------------------------------

On systems with support for **pkg-config**, use ``pkg-config --cflags
Expand Down
65 changes: 34 additions & 31 deletions README.md
View file
@@ -1,5 +1,5 @@
# OpenEXR

OpenEXR
=======

**OpenEXR** is a high dynamic-range (HDR) image file format developed
by Industrial Light & Magic (ILM) for use in computer imaging
Expand Down Expand Up @@ -39,42 +39,48 @@ OpenEXR's features include:
namespaces to provide protection when using multiple versions of the
library in the same process space.

## License
License
-------

OpenEXR, including all contributions, is released under the modified
BSD license. Please see the LICENSE file for the legal fine print.

## Sub-modules
OpenEXR Sub-modules
-------------------

The OpenEXR distribution consists of the following sub-modules:

* IlmBase - Utility libraries from Industrial Light & Magic: Half, Imath, Iex, IlmThread.
* PyIlmBase - Python bindings for the IlmBase libraries.
* OpenEXR - The core image library.
* OpenEXR_Viewers - Standard image viewing programs
* Contrib - Various plugins and utilities, contributed by the community.
* **IlmBase** - Utility libraries from Industrial Light & Magic: Half, Imath, Iex, IlmThread.
* **PyIlmBase** - Python bindings for the IlmBase libraries.
* **OpenEXR** - The core image library.
* **OpenEXR_Viewers** - Standard image viewing programs
* **Contrib** - Various plugins and utilities, contributed by the community.

Please see the README files of each of the individual directories for more information.

A collection of OpenEXR images is available from the adjacent repository
[openexr-images](https://github.com/openexr/openexr-images).

## Web Resources
Web Resources
-------------

Main web page: http:://www.openexr.org

GitHub page: http://www.github.com/openexr
GitHub repository: http://www.github.com/openexr

Mail lists:

http://lists.nongnu.org/mailman/listinfo/openexr-announce - OpenEXR-related announcements.
* **http://lists.nongnu.org/mailman/listinfo/openexr-announce** - OpenEXR-related announcements.

http://lists.nongnu.org/mailman/listinfo/openexr-user - for discussion about OpenEXR applications or general questions.
* **http://lists.nongnu.org/mailman/listinfo/openexr-user** - for discussion about OpenEXR applications or general questions.

http://lists.nongnu.org/mailman/listinfo/openexr-devel - for developers using OpenEXR in their applications.
* **http://lists.nongnu.org/mailman/listinfo/openexr-devel** - for developers using OpenEXR in their applications.

## Building and Installation
Building and Installation
-------------------------

Download the latest release of OpenEXR from http://www.openexr.com/downloads.html.
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.

Expand All @@ -84,7 +90,7 @@ Build and install the IlmBase module first, then build and install the OpenEXR m

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.

## Building with CMake
#### Building with CMake

To build with CMake, OpenEXR has a few prerequisites.

Expand All @@ -102,41 +108,38 @@ configure the OpenEXR build. The options are detailed below.
Create a build 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".

````
cmake -DCMAKE_INSTALL_PREFIX=<install location> <OpenEXR source root> -G "selected generator" -DCMAKE_PREFIX_PATH=<paths to dependencies - zlib etc>
````

cmake -DCMAKE_INSTALL_PREFIX=<install location> <OpenEXR source root> -G "selected generator" -DCMAKE_PREFIX_PATH=<paths to dependencies - zlib etc>

The available options are:

* OPENEXR_BUILD_ILMBASE (ON)
* ``OPENEXR_BUILD_ILMBASE`` (ON)
By default, IlmBase is always built.

* OPENEXR_BUILD_OPENEXR (ON)
* ``OPENEXR_BUILD_OPENEXR`` (ON)
By default, OpenEXR is always built.

* OPENEXR_BUILD_PYTHON_LIBS (ON)
* ``OPENEXR_BUILD_PYTHON_LIBS`` (ON)
By default, the Python bindings will be built.

* OPENEXR_BUILD_VIEWERS (OFF)
* ``OPENEXR_BUILD_VIEWERS`` (OFF)
By default, the viewers are not built, as they have not been updated for
modern OpenGL.

* OPENEXR_BUILD_SHARED (ON)
* OPENEXR_BUILD_STATIC (OFF)
* ``OPENEXR_BUILD_SHARED`` (ON)
* ``OPENEXR_BUILD_STATIC`` (OFF)
The build can be configured to create either shared libraries, or static
libraries, or both.

* OPENEXR_NAMESPACE_VERSIONING (ON)
* ``OPENEXR_NAMESPACE_VERSIONING`` (ON)
OpenEXR symbols will be contained within a namespace

* OPENEXR_FORCE_CXX03 (OFF)
* ``OPENEXR_FORCE_CXX03`` (OFF)
C++03 compatibility is possible as an option

* OPENEXR_ENABLE_TESTS (ON)
* ``OPENEXR_ENABLE_TESTS`` (ON)
By default, the tests will be built.

* OPENEXR_PYTHON_MAJOR, OPENEXR_PYTHON_MINOR "2", "7"
* ``OPENEXR_PYTHON_MAJOR``, ``OPENEXR_PYTHON_MINOR`` "2", "7"
By default, OpenEXR is built against Python 2.7.x.

## Documentation
Expand Down

0 comments on commit c612d82

Please sign in to comment.