Config::Installation

Steps For Installation

Pulling down the repository & dependencies

1. git clone --recursive https://github.com/TeamCobra/ouroboros.git
2. cd ouroboros
3. (optional, only to get the newest code) git checkout development
4. gem install nokogiri
5. gem install rgen
6. Doxygen is required if one wants to generate the C++ documentation

Some of the sample plugins require the embedded python libraries, bundled in some distributions as python-dev.

Build the project to run with an xml file:

1. cd src/
2. ./ouroboros_generator serverconfig.xml XML file example is named 'serverconfig.xml'
3. cd ../
4. autoreconf -fi
5. cd build
6. ../configure #details of cross-compiler can be specified here
7. make
8. cd src/ouroboros
9. ./ouroboros_server

Execute testing suite:

1. autoreconf -fi from project top directory if it hasn't been done before (or if there are errors)
2. ../configure CFLAGS and other variables can be configured here
3. make check

Output will be found in `src/test/*.log files.

Generating C++ documentation

Most of the C++ code for the project uses Doxygen-style comments that can be parsed by Doxygen. In order to generate the documentation do the following (after generating the device_tree.cpp file by running the generator):

1. cd docs
2. doxygen Doxyfile

At this point, the generated documentation will be found inside docs/html. Open docs/html/index.html in a web browser to browse through the documentation.

Playing with a few example plugin:

As a reminder, some of the sample plugins require the embedded python libraries, bundled in some distributions as python-dev. These are included in the src/ouroboros/plugin directory and the binaries need to be copied to a plugin folder in the same directory as the binary (or at least in the same directory from which the binary is run).

1. cd src/ouroboros/plugin
2. make clean
3. make
4. cd ../../../build/src/ouroboros
5. mkdir -p plugin
6. cp ../../../src/ouroboros/plugin/*.plugin ./
7. ./ouroboros_server

Generating C++ documentation

Most of the C++ code for the project uses Doxygen-style comments that can be parsed by Doxygen. In order to generate the documentation do the following (after generating the device_tree.cpp file by running the generator):

1. cd docs
2. doxygen Doxyfile

At this point, the generated documentation will be found inside docs/html. Open docs/html/index.html in a web browser to browse through the documentation.

Notes/Issues

• If you are using Linux(known to be a problem on Ubuntu), there may be a problem installing the nokogiri gem on your system. A good fix can be found here.
• For now, you'll want to make sure you have autoreconf installed for setting up the make file. On OS X you should be set to go, for Ubuntu/Linux you can go here. Once installed, run autoreconf before make in the first section. This is a bug and we are working to resolve it soon.