.. OpenFX documentation master file, created by
   sphinx-quickstart on Tue Mar 29 18:02:16 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.
.. for help on writing/extending this file, see the reStructuredText cheatsheet
   http://github.com/ralsina/rst-cheatsheet/raw/master/rst-cheatsheet.pdf

Welcome to OpenFX documentation
==============================

The OpenFX documentation is organized as follows:

- The :ref:`programming guide<ofxProgrammingGuide>` contains  everything to get started with OpenFX to create a new plug-in or host application
- The :ref:`reference guide<ofxProgrammingReference>` contains the full documentation about the OpenFX protocol and design

This documentation is also
`available online <http://openfx.readthedocs.io/en/master/>`_
and can be downloaded as a
`PDF <https://readthedocs.org/projects/openfx/downloads/pdf/master/>`_ or
`HTML zip <https://readthedocs.org/projects/openfx/downloads/htmlzip/master/>`_
file.

This manual is maintained largely by volunteers.

The `Creative Commons Attribution-ShareAlike 4.0 International License (CC-BY-SA 4.0) <https://creativecommons.org/licenses/by-sa/4.0/>`_ is used for this manual, which is a free and open license. Though there are certain restrictions that come with this license you may in general freely reproduce it and even make changes to it. However, rather than distribute your own version of this manual, we would much prefer if you would send any corrections or changes to the OpenFX association.

.. toctree::
    :maxdepth: 1

    Reference/index
    Guide/index

