Obtaining the library source from Subversion

Note: This Page needs to be updated to 0.5.0

All the code for CrazyEddie's GUI System (and the layout editor) is kept in a revision control system known as Subversion(SVN). This is a tool that allows us to easily track changes to the code (who did what, and when), to maintain multiple different versions (branches) for the code, and, where necessary, undo, revert, or merge code changes.

Generally speaking, each stable release series has a seperate branch, and any changes made on those branches are largely bug-fixes and non-breaking (where possible) changes. The main 'trunk' code is where the latest and greatest code can be found, although this version of the code is generally to be considered as unstable / testing code. On the whole, we maintain two branches at once; whichever is the latest 'stable' branch, and the main trunk code. When a new release is made, previous release branches are generally considered obsolete (this will continue at least until we reach version 1.0.0 - at this stage we may consider maintaining support for multiple released versions).

It is possible to browse the SVN repository online by visiting http://svn.sourceforge.net/viewcvs.cgi/crayzedsgui/cegui_mk2/

NOTE that the layout editor is a bit more difficult to get running from sources, so it has its own page dedicated to the process: http://www.cegui.org.uk/wiki/index.php/Getting_Started

Getting the Code

To obtain the code you use the Subversion client command 'svn', and the command is to get the trunk code is simply:

svn co https://svn.sourceforge.net/svnroot/crayzedsgui/cegui_mk2/trunk cegui_mk2-trunk

This will 'checkout' the code from SVN, and place it in the directory 'cegui_mk2-trunk'

If you want to obtain the latest code in from one of the stable branches, then the command you should issue is:

svn co https://svn.sourceforge.net/svnroot/crayzedsgui/cegui_mk2/branches/v0-4 cegui_mk2-0-4

This will get you the latest code from the stable 'v0-4' branch (release series 0.4.x), and place it in the directory 'cegui_mk2-0-4'

---

With the Tortoise SVN Client, right-click within a directory and select "SVN Checkout..." from the popup menu. Specify the "URL of repository" as:

https://svn.sourceforge.net/svnroot/crayzedsgui/cegui_mk2/trunk

Compiling

Now that you have the code, you probably want to compile it ;)

The first thing to do is to run bootstrap, which will run automake, autoconf, and various other tools to initialise the build environment and create the main configure script. If you have problems with bootstrap, make sure you're using a recent version of automake (1.9 is known to work).

./bootstrap

Now you should be on familiar territorty. To configure the build, run configure:

./configure

There are various things you can change about the way the system is built, to get information about these options, pass the --help option to configure like so:

./configure --help

Once configure has run successfully, you need to run make as usual:

make

And finall, install as root:

su  <and enter password ;) >
make install

CrazyEddie 11:13, 3 April 2006 (PDT)