====================================
                    Research on Self-Awareness Framework
                    ====================================

Build Dependencies:
------------------

* CMake (minimum version 2.8.8)
* Build system of your choice with a standard C++ compiler (targeted by CMake)

Runtime Dependencies:
--------------------

Nothing yet :)

Build:
-----

The framework is delivered with a CMake project, which can be used to generate
build projects to build the framework. Consult README.build for details.

Using YCM:
---------

If you happen to use YMC, just make a copy of the provided
ycm_extra_conf.py.template file as .ycm_extra_conf.py in the project directory,
and set the following two variables in it:
 * compilation_database_folder: the absolute path of your build directory
 * extra_system_include_dirs: any system include directory which might not be
   search by libclang.
   See: https://github.com/Valloric/YouCompleteMe/issues/303; use the
   following command to figure out the used system directories:
   'echo | clang -std=c++11 -v -E -x c++ -'.

You probably want compile with clang if you use YCM, so run cmake with
environment variables CC=clang and CXX=clang++ set.

Also note that header files in the include directory are compiled for YCM with
the compiler flags of a corresponding source file in the lib directory, if any.
Header files in other locations are supposed to have a corresponding source
file in the same directory.
If the project's include directory (include/rosa) would be ever changed, then
that needs to be also modified in the YCM configuration file.