Difference between revisions of "Getting Started with Development"

From PioneerWiki
Jump to: navigation, search
(Scrap notes about how to build; point to COMPILING.txt in the repository instead)
(Getting the Code)
Line 6: Line 6:
 
This will get you on the "master" branch, which is where new code is merged. This is the latest and greatest development and is quite unstable. To build a specific alpha, you need to checkout the appropriate release tag:
 
This will get you on the "master" branch, which is where new code is merged. This is the latest and greatest development and is quite unstable. To build a specific alpha, you need to checkout the appropriate release tag:
  
  git checkout alpha20
+
  git checkout alpha30
 +
 
 +
You may also need to clone the [https://github.com/pioneerspacesim/pioneer-thirdparty pioneer-thirdparty] repository, depending on what platform you're on. It is needed to build on Windows. You should clone this in a directory ''next to'' your clone of the pioneer directory (''not'' a sub-directory). Further instructions are in the COMPILING.txt file (linked below).
  
 
==Compiling==
 
==Compiling==

Revision as of 13:38, 25 January 2013

Getting the Code

Pioneer is managed using Git, and is stored on Github. The official repository is the best one to get. To get it:

git clone git://github.com/pioneerspacesim/pioneer.git

This will get you on the "master" branch, which is where new code is merged. This is the latest and greatest development and is quite unstable. To build a specific alpha, you need to checkout the appropriate release tag:

git checkout alpha30

You may also need to clone the pioneer-thirdparty repository, depending on what platform you're on. It is needed to build on Windows. You should clone this in a directory next to your clone of the pioneer directory (not a sub-directory). Further instructions are in the COMPILING.txt file (linked below).

Compiling

There are instructions for how to compile the code included in the repository:

COMPILING.txt

Debugging

For developers on Linux, gdb can be used for debugging

gdb ./src/pioneer
run

Bugs, and feature requests, should be logged on the issue tracker.