==================
The RoSA Framework
==================

.. contents::
   :local:

Overview
========

The RoSA (Research on Self-Awareness) Framework is intended to be used as a tool
for experimenting and evaluating new ways of implementing self-aware
applications.

This documentation was generated for RoSA version |release| on |today|.

Documentation
=============

.. toctree::
   :hidden:

   Changelog
   Use
   Build
   Dev
   Issues
   Release
   Plan
   CommandGuide/index

:doc:`Use`
  Describes how to create your own software based on RoSA.

:doc:`Build`
  Describes how to build RoSA.

:doc:`Dev`
  Provides basic information for developers on how to contribute to RoSA.

:doc:`Issues`
  Known issues and things to do with the current implementation of RoSA.

:doc:`Release`
  Describes for maintainers how to make a new release of RoSA.

:doc:`Plan`
  Discusses future work and possible ways to develop RoSA.

:doc:`CommandGuide/index`
  Documentation for RoSA applications and tools.

Changes
=======

Refer to :doc:`Changelog`.

.. _API_Documentation:

API Documentation
=================

For details of the provided interface, refer to our `API documentation`_.

.. _API documentation: ../doxygen/html/index.html

Indices and Tables
==================

* :ref:`genindex`
* :ref:`search`