X-Git-Url: http://users.mur.at/ms/git/gitweb/?a=blobdiff_plain;f=aces_1.0.0%2Fpython%2Faces_ocio%2F__init__.py;h=3d3363507f1dbd350eff39c458a94474c9c3463d;hb=24460c4f42d9e44101d414ef15579e5f7d250bb7;hp=73ec1535c25c85786556c1c1d8954e0d8beb988b;hpb=2158c15470d514412974585e84210cbc2c909011;p=OpenColorIO-Configs.git

diff --git a/aces_1.0.0/python/aces_ocio/__init__.py b/aces_1.0.0/python/aces_ocio/__init__.py
index 73ec153..3d33635 100644
--- a/aces_1.0.0/python/aces_ocio/__init__.py
+++ b/aces_1.0.0/python/aces_ocio/__init__.py
@@ -11,19 +11,33 @@ Usage
 Python
 ******
 
->>> import sys
->>> sys.path.append('/path/to/script')
->>> import create_aces_config as cac
->>> acesReleaseCTLDir = '/path/to/github/checkout/releases/v0.7.1/transforms/ctl'
->>> configDir = '/path/to/config/dir'
->>> cac.createACESConfig(acesReleaseCTLDir, configDir, 1024, 33, True)
+>>> from aces_ocio.create_aces_config import create_ACES_config
+>>> aces_ctl_directory = '/path/to/github/checkout/releases/v1.0.0/transforms/ctl'
+>>> config_directory = '/path/to/configuration/dir'
+>>> create_ACES_config(aces_ctl_directory, config_directory, 1024, 33, True)
 
 Command Line
 ************
 
-From the directory with 'create_aces_config.py':
+Using the *create_aces_config* binary:
 
-$ python create_aces_config.py -a '/path/to/github/checkout/releases/v0.7.1/transforms/ctl' -c '/path/to/config/dir' --lut_resolution_1d 1024 --lut_resolution_3d 33 --keepTempImages
+$ create_aces_config -a '/path/to/github/checkout/releases/v0.7.1/transforms/ctl' -c '/path/to/config/dir' --lutResolution1d 1024 --lutResolution3d 33 --keepTempImages
+
+It is possible to set the following environment variables to avoid passing
+the paths to the binary:
+
+- *ACES_OCIO_CTL_DIRECTORY*
+- *ACES_OCIO_CONFIGURATION_DIRECTORY*
+
+The above command line call would be done as follows:
+
+$ create_aces_config --lutResolution1d 1024 --lutResolution3d 33 --keepTempImages
+
+Testing the generated configuration is needs the
+*ACES_OCIO_CTL_DIRECTORY* environment variable to be set and is done as
+follows:
+
+$ tests_aces_config
 
 Build
 -----