Version 1 (modified by ibboard, 8 years ago) (diff)


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.


To build and develop the #WarFoundry tools you need:

Getting the source code

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

WarFoundry API projects, plus:

Project nameMercurial locationDescription
IBBoard.Windows.Forms Custom System.Windows.Forms controls
IBBoard.WarFoundry.GUI.WinForms System.Windows.Forms interface for WarFoundry

WarFoundry GTK#

WarFoundry API projects, plus:

Project nameMercurial locationDescription
IBBoard.GtkSharp Custom GTK# controls and helper methods
IBBoard.WarFoundry.GUI.GTK GTK# interface for WarFoundry

WarFoundry Qt# (Qyoto)

WarFoundry API projects, plus:

Project nameMercurial locationDescription
IBBoard.WarFoundry.GUI.QtSharp Qt#/Qyoto interface for WarFoundry

WarFoundry API

Project nameMercurial locationDescription
IBBoard Core IBBoard utils
IBBoard.WarFoundry.API Core API for WarFoundry
SharpZipLib Custom build of SharpZipLib because of bug #311

WarFoundry API Tests

Project nameMercurial locationDescription
IBBoard.Tests Tests for core IBBoard utils (optional - only necessary if you modify the utils library)
IBBoard.NUnit Extra NUnit methods (optional - currently only required if you get IBBoard.Tests)
IBBoard.WarFoundry.API.Tests Tests for the core WarFoundry API

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 contribute, read the Contributing instructions.