Changes between Initial Version and Version 1 of Development/QuickStart


Ignore:
Timestamp:
08/14/11 19:48:08 (8 years ago)
Author:
ibboard
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Development/QuickStart

    v1 v1  
     1[[PageOutline(2-5)]]
     2= Getting Started - Quick Start Guide =
     3
     4The following is the quick-start guide for working with WarFoundry. More detail is available in the [../GettingStarted Getting Started pages].
     5
     6== Pre-requisites ==
     7
     8To build and develop the #WarFoundry tools you need:
     9 * a .Net framework
     10  * Mono 2.0 or later (Linux, Mac OS X, or
     11  * Microsoft .Net 2.0 or later (Windows)
     12 * a development environment
     13  * [http://monodevelop.com MonoDevelop] (Linux, Mac OS X or Windows)
     14  * Visual Studio or [http://www.microsoft.com/express Visual Studio Express C# Edition] 2010 (Windows)
     15  * [http://sharpdevelop.net/opensource/sd/ SharpDevelop] (Windows)
     16 * NUnit (for unit tests)
     17  * [http://sourceforge.net/projects/nunit/files/NUnit%20Version%202/V2.4.8/ NUnit v2.4.8] is recommended - later versions made incompatible changes
     18 * [../GettingStarted/MercurialClients Mercurial source control client] (e.g. TortoiseHg)
     19
     20== Getting the source code ==
     21
     22If 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.
     23
     24=== !WarFoundry WinForms ===
     25
     26[#WarFoundryAPI WarFoundry API] projects, plus:
     27||'''Project name'''||'''Mercurial location'''||'''Description'''||
     28|| IBBoard.Windows.Forms || http://dev.ibboard.co.uk/repos/IBBoard.Windows.Forms || Custom System.Windows.Forms controls ||
     29|| IBBoard.!WarFoundry.GUI.!WinForms || http://dev.ibboard.co.uk/repos/IBBoard.WarFoundry.GUI.WinForms || System.Windows.Forms interface for !WarFoundry ||
     30
     31=== !WarFoundry GTK# ===
     32
     33[#WarFoundryAPI WarFoundry API] projects, plus:
     34||'''Project name'''||'''Mercurial location'''||'''Description'''||
     35|| IBBoard.GtkSharp || http://dev.ibboard.co.uk/repos/IBBoard.GtkSharp || Custom GTK# controls and helper methods ||
     36|| IBBoard.!WarFoundry.GUI.GTK || http://dev.ibboard.co.uk/repos/IBBoard.WarFoundry.GUI.GTK || GTK# interface for !WarFoundry ||
     37
     38=== !WarFoundry Qt# (Qyoto) ===
     39
     40[#WarFoundryAPI WarFoundry API] projects, plus:
     41||'''Project name'''||'''Mercurial location'''||'''Description'''||
     42|| IBBoard.!WarFoundry.GUI.QtSharp || http://dev.ibboard.co.uk/repos/IBBoard.WarFoundry.GUI.QtSharp || Qt#/Qyoto interface for !WarFoundry ||
     43
     44=== !WarFoundry API ===
     45
     46||'''Project name'''||'''Mercurial location'''||'''Description'''||
     47|| IBBoard || http://dev.ibboard.co.uk/repos/IBBoard || Core IBBoard utils ||
     48|| IBBoard.!WarFoundry.API || http://dev.ibboard.co.uk/repos/IBBoard.WarFoundry.API || Core API for !WarFoundry ||
     49|| SharpZipLib || http://dev.ibboard.co.uk/repos/SharpZipLib || Custom build of SharpZipLib because of bug #311 ||
     50
     51=== !WarFoundry API Tests ===
     52
     53||'''Project name'''||'''Mercurial location'''||'''Description'''||
     54|| IBBoard.Tests || http://dev.ibboard.co.uk/repos/IBBoard.Tests || Tests for core IBBoard utils (optional - only necessary if you modify the utils library) ||
     55|| IBBoard.NUnit || http://dev.ibboard.co.uk/repos/IBBoard.NUnit || Extra NUnit methods (optional - currently only required if you get IBBoard.Tests)  ||
     56|| IBBoard.!WarFoundry.API.Tests || http://dev.ibboard.co.uk/repos/IBBoard.WarFoundry.API.Tests || Tests for the core !WarFoundry API ||
     57
     58== Contributing changes ==
     59
     60Once 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.
     61
     62For more details on how to contribute, read the [../Contributing Contributing] instructions.