summaryrefslogtreecommitdiff
path: root/docs/index.rst
blob: 3757b669d6f5371a0438afdb7aed1c472105b2b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
Home
====

.. include:: README

.. _mailing_lists:

Mailing lists
"""""""""""""

There are two mailing lists associated with OpenColorIO:

`ocio-users <http://groups.google.com/group/ocio-users>`__\ ``@googlegroups.com``
    For end users (artists, often) interested in OCIO profile design,
    facility color management, and workflow.

`ocio-dev <http://groups.google.com/group/ocio-dev>`__\ ``@googlegroups.com``
    For developers interested OCIO APIs, code integration, compilation, etc.

Using OpenColorIO
"""""""""""""""""

Most users will likely want to use the OpenColorIO that comes precompiled with
their applications.  See the :ref:`compatiblesoftware` for further details on
each application.

Note that OCIO configurations aren't required to do any 'real' work, and are
available separately on the :ref:`downloads` section of this site. Example
images are also available. For assistance customizing .ocio configurations,
contact the ocio-users email alias.

- Step 1:  set the OCIO environment-variable to /path/to/your/profile.ocio
- Step 2:  Launch supported application.

If you are on a platform that is not envvar friendly, most applications also
provide a menu option to select a different OCIO configuration after launch.

Please be sure to select a profile that matches your color workflow (VFX work
typically requires a different profile than animated features). If you need
assistance picking a profile, email ocio-users.

Downloading and building the code
"""""""""""""""""""""""""""""""""

Source code is available on Github at
http://github.com/imageworks/OpenColorIO

Download a `.zip <http://github.com/imageworks/OpenColorIO/zipball/master>`_ or
`.tar.gz <http://github.com/imageworks/OpenColorIO/tarball/master>`_ of the
current state of the repository.

Please see the :ref:`developer-guide` for more info, and contact ocio-dev with any
questions.

.. toctree::
    :hidden:
    :maxdepth: 2
    
    self
    CompatibleSoftware
    
    configurations/index
    installation
    
    userguide/index
    
    developers/index
    
    FAQ
    downloads
    
    ChangeLog
    License

:ref:`search`

:ref:`genindex`