Getting Started - Quick Start Guide

The following is the quick-start guide for working with WarFoundry. More detail is available in the Getting Started pages.

Pre-requisites

To build and develop the #WarFoundry tools you need:

• a .Net framework
  • Mono 2.0 or later (Linux, Mac OS X, or
  • Microsoft .Net 2.0 or later (Windows)
• a development environment
  • ​MonoDevelop (Linux, Mac OS X or Windows)
  • Visual Studio or ​Visual Studio Express C# Edition 2010 (Windows)
  • ​SharpDevelop (Windows)
• NUnit (for unit tests)
  • ​NUnit v2.4.8 is recommended - later versions made incompatible changes
• Mercurial source control client (e.g. TortoiseHg)

Getting the source code

To build/develop WarFoundry, you'll need to clone the following repositories (pick the appropriate ones for the GUI you're working with). To make use of the existing solution files, put them all in the same folder.

If building from source, you can ignore the test projects. For development work, please also get the unit test projects and run the unit tests to ensure everything still works.

WarFoundry WinForms

Project name	Mercurial location	Description
IBBoard.Windows.Forms	​http://dev.ibboard.co.uk/repos/IBBoard.Windows.Forms	Custom System.Windows.Forms controls
IBBoard.WarFoundry.GUI.WinForms	​http://dev.ibboard.co.uk/repos/IBBoard.WarFoundry.GUI.WinForms	System.Windows.Forms interface for WarFoundry

Plus WarFoundry API projects.

WarFoundry GTK#

Project name	Mercurial location	Description
IBBoard.GtkSharp	​http://dev.ibboard.co.uk/repos/IBBoard.GtkSharp	Custom GTK# controls and helper methods
IBBoard.WarFoundry.GUI.GTK	​http://dev.ibboard.co.uk/repos/IBBoard.WarFoundry.GUI.GTK	GTK# interface for WarFoundry

Plus WarFoundry API projects.

WarFoundry Qt# (Qyoto)

Project name	Mercurial location	Description
IBBoard.WarFoundry.GUI.QtSharp	​http://dev.ibboard.co.uk/repos/IBBoard.WarFoundry.GUI.QtSharp	Qt#/Qyoto interface for WarFoundry

Plus WarFoundry API projects.

WarFoundry API

Project name	Mercurial location	Description
IBBoard	​http://dev.ibboard.co.uk/repos/IBBoard	Core IBBoard utils
IBBoard.WarFoundry.API	​http://dev.ibboard.co.uk/repos/IBBoard.WarFoundry.API	Core API for WarFoundry
SharpZipLib	​http://dev.ibboard.co.uk/repos/SharpZipLib	Custom build of SharpZipLib because of bug #311

WarFoundry API Tests

Project name	Mercurial location	Description
IBBoard.Tests	​http://dev.ibboard.co.uk/repos/IBBoard.Tests	Tests for core IBBoard utils (optional - only necessary if you modify the utils library)
IBBoard.NUnit	​http://dev.ibboard.co.uk/repos/IBBoard.NUnit	Extra NUnit methods (optional - currently only required if you get IBBoard.Tests)
IBBoard.WarFoundry.API.Tests	​http://dev.ibboard.co.uk/repos/IBBoard.WarFoundry.API.Tests	Tests for the core WarFoundry API

Opening the projects

Each of the GUI projects (IBBoard.WarFoundry.GUI.GTK, IBBoard.WarFoundry.GUI.QtSharp and IBBoard.WarFoundry.GUI.WinForms) contains a .sln file. If all of your projects are in the same parent folder then opening this file in your IDE of choice will load the project.

Contributing changes

Once you've got the code then you can build and run it. You can also make changes and make local commits, but they won't be visible to anyone else until you share them.

For more details on how to share your contributions, read the Contributing instructions.