Changes between Initial Version and Version 1 of Development/GettingStarted

03/01/09 10:48:49 (11 years ago)



  • Development/GettingStarted

    v1 v1  
     2= Getting Started =
     4The following instructions should help you get started with the WarFoundry source code so that you can explore it and start working with it.
     6== Required Tools ==
     8There are only really two main tools needed for developing WarFoundry, an SVN client and a development environment. As WarFoundry is built using C# 2.0 you'll also need a .Net 2.0 compatible framework such as [ Mono] (which may already be installed on some Linux distros) or Microsoft's [ .Net framework] (which may already be installed on some versions of Windows).
     10=== Development Environment ===
     12All of the WarFoundry projects use Visual Studio 2005 project files, as 2005 includes useful features like [ Generics] without the [ huge framework download] and lack of open-source support.
     14For System.Windows.Forms development (Windows-based applications), using Visual Studio 2005 is recommended. Microsoft make versions of [ Visual Studio 2005 Express] available for free. Although they're not as feature complete as the full version and don't (officially) support plugins, they seem more than adequate for the current WarFoundry work.
     16For GTK# and other non-System.Windows.Forms development, using [ MonoDevelop] is recommended. MonoDevelop isn't as powerful as Eclipse for Java development, but it does have a plugin architecture (including SVN support) and a GTK GUI editor.
     18Other development environments may also be suitable, depending on taste, (e.g. Eclipse with a Mono/.Net plugin, or SharpDevelop) but Visual Studio Express 2005 and MonoDevelop have been adequate and useful for all current development.
     20=== SVN Client ===
     22The easiest way to work with SVN is when source control is integrated in to your development environment. Unfortunately, Subversion plugins for Visual Studio normally come with a price tag and aren't compatible with Visual Studio Express (which leaves you with an even bigger price tag on Visual Studio).
     24==== SVN in MonoDevelop ====
     26If you are using MonoDevelop then integrated subversion is already built-in through the supplied plugins. If the plugin is disabled then check that the Subversion client executable is installed on your computer. MonoDevelop will write a warning to the console if the plugin is enabled but it can't find the subversion executable, but not warn you through the GUI. Once MonoDevelop can see the subversion executable you should have a "Checkout" menu item under the "File" menu.
     28==== SVN in Visual Studio ====
     30There are several SVN plugins for Visual Studio, but all of the ones I've seen have a price tag and aren't compatible with Visual Studio Express editions. This is part of Microsoft's general tactic of getting people used to core functionality and then get the money when they want advanced functionality. The easiest solution (if you don't already have a full copy of Visual Studio) is to use an external SVN client.
     32==== External SVN clients ====
     34If your development environment doesn't include SVN integration then the easiest alternative is an external client. There are [ lots of clients] for all OSes. The most popular client for Windows seems to be TortoiseSVN, while most Linux developers tend to have development environments that include source control as a core feature.
     36==== SVN from the command-line ====
     38The brave can always use SVN from the command-line. While it does have its uses, it's not generally advised for long-term use. Command-line arguments and usage instructions can be found in the [ SVN book at].
     40== Getting the source code ==
     42Exact details of how to get the source code will vary by client, but the following are the required projects to work with WarFoundry.
     44Some projects also have companion "Test" projects. These can be identified by having the same project name, except that ".Tests" is appended. It is recommended that you also download the tests and run them regularly as you make changes to make sure that nothing is broken. Everything should also have unit tests added as/before it is written, although up until now this hasn't been the case.
     46=== WarFoundry Core ===
     48 * [svn:// IBBoard] - core IBBoard utils
     49 * [svn:// IBBoard.WarFoundry.API] - core API for WarFoundry
     51=== WarFoundry GTK# ===
     53 * [svn:// IBBoard.Log4Net] - Logging support (for use with the LogNotifier in the IBBoard core utils)
     54 * [svn:// IBBoard.WarFoundry.GUI.GTK] - GTK# interface for WarFoundry
     56Also, while the Rollcall plugin is still hard-coded in to the GTK# app for testing the following are also needed:
     57 * [svn:// IBBoard.Ini] - INI file parsing for Rollcall
     58 * [svn:// IBBoard.WarFoundry.Plugin.Rollcall] - Rollcall ADF file support
     60=== WarFoundry SWF ===
     62 * [svn:// IBBoard.Log4Net] - Logging support (for use with the LogNotifier in the IBBoard core utils)
     63 * [svn:// IBBoard.WarFoundry.GUI.WinForms] - System.Windows.Forms interface for WarFoundry