Building from source

From CEGUI Wiki - Crazy Eddie's GUI System (Open Source)
Revision as of 13:28, 16 December 2011 by Pav (Talk | contribs) (Work in progress)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Written for CEGUI 0.8

Works with versions 0.8.x (stable)

Works with latest CEGUI stable!

This article is a work in progress and thus incomplete


Obtaining the source

Note: If you'd rather use precompiled SDKs, please follow Downloads.

Stable Releases

Source code from the stable mercurial branches is released at various points in time and made available as source code packages. These packages can be found on the Downloads page.

Mercurial

The source code is kept in mercurial repositories at sourceforge.net. There are code repositories for the main CEGUI libraries as well as for other related items.

A mercurial client (GUI or CLI) is required to access the mercurial repositories and download code. The command necessary to obtain a copy of the code is 'clone': 

hg clone SOURCE DESTINATION

where source is the URL of the repository to clone and destination is the local directory. To download a copy of CEGUI and place it in the cegui-source directory, you might use the following command: 

hg clone http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/cegui_mk2 cegui-source

Once you have this, the cloned repository is updated to the default (latest, unstable) code, so you most likely will want to switch to a stable branch instead, like this: 

hg update -C v0-8
Warning: Be aware that the -C option here will discard any local file changes without additional warning

Repositories

The available repositories can be found here where you can also browse their code from your web browser. A couple of examples: 

hg clone http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/cegui_mk2 cegui-source
  • CEED unified editor - CEED
hg clone http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/CEED
Note: The difference between the hg clone URLs and the web-interface URLs is hgroot vs hgweb

Building

Todo: CMake system intro
Todo: Proposed directory structure so that CEED (which depends on CEGUI) works

CEGUI

Todo: Short description

Dependencies

Todo: Modular design and dependencies

Build Options

Todo: CMake options

Building

Todo: Build general

Windows

Todo: Windows notes

Mac

Todo: Mac notes

Linux

Todo: Linux notes
Distro1
Todo: Distro specific notes

Documentation

Note: The documentation for stable releases can be found online here
Todo: Doxygen howto

CEED

Todo: Short description

Dependencies

Todo: Dependencies general

Windows

Todo: Windows deps & notes

Mac

Todo: Mac deps & notes

Linux

Todo: Linux deps & notes
Distro1
Todo: Distro specific deps & notes

Running

Todo: Running

Troubleshooting

Todo: Problems? -> Forum!

Related Articles

Retrieved from "http://cegui.org/wiki/index.php?title=Building_from_source&oldid=4675"