==========
Contribute
==========

The ITK Examples are stored in the Git_ distributed version control system, and
the mainline repository can be found at ITKExamplesRepo_.  Files
in the repository can be edited either with the `web interface`_ or the typical
`text editor / version control workflow`_ used when modifying source code.

Examples code can be written in the C++, Python, or Java programming languages.
Documentation for the examples is writted in reStructuredText_ / Sphinx_.  A
Sphinx is a build system that uses the reStructuredText syntax with additional
capabilies such as multi-document projects and rendering of LaTeX-style
equations.  A good reference for the easy-to-learn reStructuredText syntax is
the `Quick reStructuredText`_ guide.

.. _`web interface`:

Contribute with the web interface
=================================


Modifying an existing example
-----------------------------

Todo.

Create a new example
--------------------

Todo.

.. _`text editor / version control workflow`:

Contribute with Git
===================

Modifying an existing example
-----------------------------

Todo.

Create a new example
--------------------

Todo.

Peer review with Gerrit
=======================

Todo.

.. _ITKExamplesRepo:        http://itk.org/ITKExamples.git
.. _Git:                    http://git-scm.com/
.. _reStructuredText:       http://docutils.sourceforge.net/rst.html
.. _Sphinx:                 http://sphinx.pocoo.org/
.. _Quick reStructuredText: http://docutils.sourceforge.net/docs/user/rst/quickref.html

==========
Contribute
==========

The ITK Examples are stored in the Git_ distributed version control system, and
the mainline repository can be found at ITKExamplesRepo_.  Files
in the repository can be edited either with the `web interface`_ or the typical
`text editor / version control workflow`_ used when modifying source code.

Examples code can be written in the C++, Python, or Java programming languages.
Documentation for the examples is writted in reStructuredText_ / Sphinx_.  A
Sphinx is a build system that uses the reStructuredText syntax with additional
capabilies such as multi-document projects and rendering of LaTeX-style
equations.  A good reference for the easy-to-learn reStructuredText syntax is
the `Quick reStructuredText`_ guide.

.. _`web interface`:

Contribute with the web interface
=================================


Modifying an existing example
-----------------------------

Todo.

Create a new example
--------------------

Todo.

.. _`text editor / version control workflow`:

Contribute with Git
===================

Modifying an existing example
-----------------------------

Todo.

Create a new example
--------------------

Todo.

Peer review with Gerrit
=======================

Todo.

.. todo:: replace with http://itk.org/ITKExamples/
.. _ITKExamplesRepo:        http://mmmccormick.com/ITKExamples
.. _Git:                    http://git-scm.com/
.. _reStructuredText:       http://docutils.sourceforge.net/rst.html
.. _Sphinx:                 http://sphinx.pocoo.org/
.. _Quick reStructuredText: http://docutils.sourceforge.net/docs/user/rst/quickref.html

Fix the last linkcheck error.
Fix the last linkcheck error.

We can set it back after we the repo on itk.org.
