Difference between revisions of "Developing Oolite"
(→Documentation) |
|||
| Line 40: | Line 40: | ||
= Documentation = |
= Documentation = |
||
| + | |||
| + | The documentation is automatically generated from the source code. |
||
| + | When generated, it's 700mb heavy ! |
||
== Pre-requisites == |
== Pre-requisites == |
||
| + | |||
| + | Installing Doxygen |
||
=== On Windows === |
=== On Windows === |
||
| Line 52: | Line 57: | ||
=== On Linux === |
=== On Linux === |
||
| + | |||
| + | It depends on your distribution. For Ubuntu: |
||
| + | <code>sudo apt-get install doxygen</code> |
||
== Generation == |
== Generation == |
||
Revision as of 14:04, 19 March 2015
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:
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
Setting up your development environment
On Windows
to be completed
On Mac OSX
to be completed
