Developing Oolite

From Elite Wiki
Revision as of 13:33, 19 March 2015 by Day (talk | contribs) (On Linux)

Overview

This page intends to allow you to setup an environment to develop Oolite.

Versioning

When developing software, each little modification is tracked independently and assigned a version identifier. That's called versioning. To do this, we use the git software.

The Oolite code is hosted on a git-friendly repository: github.

Creating a GitHub account

Go to https://github.com/ and create an account.

Creating a branch on GitHub

Fork the oolite main branch.

Fetching your branch

On Windows

to be completed

On Mac OSX

to be completed

On Linux

Installing git

It depends on your distribution. For ubuntu: sudo apt-get install git

Fetching

$git fetch --help

Documentation

The documentation is automatically generated from the source code. When generated, it's 700mb heavy !

Pre-requisites

Installing Doxygen

On Windows

to be completed

On Mac OSX

to be completed

On Linux

It depends on your distribution. For Ubuntu: sudo apt-get install doxygen

Generation

On Windows

to be completed

On Mac OSX

to be completed

On Linux

The documentation is generated in a html sub-directory. Go into your oolite directory and just do: $doxygen Doxyfile

Setting up your development environment

On Windows

to be completed

On Mac OSX

to be completed

On Linux