.. _preparation:

=============
 Preparation
=============

Installing |project|
====================

There are currently two ways to install the |version| version of
|project|:

* Binary downloads
* Debian packages
* From source

Binary Downloads of |project| Tools
-----------------------------------

#. Download the |main_binary| binary from the appropriate location:

   * `Linux i686 <https://ci.cor-lab.de/job/rsb-test-cl-trunk/label=ubuntu_lucid_32bit/>`_
   * `Linux x86_64 <https://ci.cor-lab.de/job/rsb-test-cl-trunk/label=ubuntu_lucid_64bit/>`_
   * `MacOS x86_64 <https://ci.cor-lab.de/job/rsb-test-cl-trunk/label=MAC_OS_lion_64bit/>`_

#. After the download, the |main_binary| file has to be made
   executable in most cases. This can be done for example by executing

   .. code-block:: sh

      $ chmod +x component-test

   in the download directory.

From Source
-----------

#. The whole source tree of |project| can be obtained from the
   repository located at |repository_versioned|.

#. TODO

Debian Packages
---------------

Debian packages for several versions of |ubuntu| are available from
the `CoR-Lab package repository
<http://packages.cor-lab.de/ubuntu/dists/>`_.

#. The following repository source line has to be added to
   ``/etc/apt/sources.list``::

     deb http://packages.cor-lab.de/ubuntu/ RELEASENAME testing

   where :samp:`RELEASENAME` is the appropriate Ubuntu release name.

#. After that, packages can be installed via

   .. code-block:: sh

      $ sudo apt-get install PACKAGE

   where :samp:`{PACKAGE}` is |package_names|.

.. warning::

   This installation method only works with |ubuntu|.

.. note::

   More information can be found `here
   <https://support.cor-lab.org/projects/ciserver/wiki/RepositoryUsage>`_.

Running the Examples
====================

TODO

.. _troubleshooting:

Troubleshooting
===============

*No problems yet*