=====Overview=====

The following instructions detail building XTrackCAD using CMake.  CMake is a cross-platform build system, available at http://www.cmake.org, that can be used to generate builds for a variety of build tools ranging from "make" to Visual Studio and XCode.  Using CMake you can build XTrackCAD on Windows, GNU/Linux, and Mac OSX using the build tool(s) of your choice.

=====Building XTrackCAD on GNU/Linux=====

	- 	Obtain the current sources from CVS; I assume that they are located at "~/src/xtrkcad".
	- 	Create a separate build directory; for these instructions I assume that your build directory is "~/build/xtrkcad".
	- 	Run CMake from the build directory, passing it the path to the source directory:

%%
$ cd ~/build/xtrkcad
$ ccmake ~/src/xtrkcad
%%

	- Press the "c" key to configure the build.  After a few moments you will see four options to configure: CMAKE_BUILD_TYPE, CMAKE_INSTALL_PREFIX, XTRKCAD_USE_GTK, and XTRKCAD_USE_GTK_CAIRO.
	- Use CMAKE_BUILD_TYPE to control the build type.  Enter "Debug" for a debug build, "Release" for a release build, etc.
	- Use CMAKE_INSTALL_PREFIX to control where the software will be installed.  For this example, I assume "~/install/xtrkcad".
	- Use XTRKCAD_USE_GETTEXT to add new locales (language translations). Choose "OFF" to use XTrackCAD's default language (English). Refer to http://www.xtrkcad.org/Wikka/Internationalization for additional information.
	- Use XTRKCAD_USE_GTK to control the user-interface back-end.  Choose "OFF" for Windows, "ON" for all other platforms.
	- Use XTRKCAD_USE_GTK_CAIRO to enable optional high-quality antialiased Cairo rendering for the GTK back-end.  This option has no effect unless you are using the GTK back-end.
	- If you made any changes, press the "c" key again to update your new configuration.
	- Once everything is configured to your satisfaction, press the "g" key to generate makefiles for your build.
	- Compile XTrackCad using your new build:

%%
$ make
%%

	- Install the new binary:

%%
$ make install
%%

	- Run the installed binary:

%%
$ ~/install/xtrkcad/bin/xtrkcad
%%

=====Building XTrackCAD on Mac OSX=====

	- You will need to install the following dependencies - I recommend using http://www.macports.org to obtain them:
		- GTK2
		- gtkhtml (might also be called libgtkhtml)
		- gnome-icon-theme
	- Once the prerequisites are installed the build instructions are the same as for the GNU/Linux build, above.
	- Remember that to run XTrackCAD on OSX, you need to have X11 running with your DISPLAY set.

=====Building XTrackCAD on Windows=====

	- Obtain the current sources from CVS; I assume that they are located at "c:/src/xtrkcad".
	- Use the Windows Start menu to run CMake.
	- Specify the source and build directories in the CMake window.  You must provide a build directory outside the source tree - I use "c:/build/xtrkcad".
	- Press the "Configure" button to configure the build.  You will be prompted for the type of build to generate.  Choose your desired tool - I used  "Visual Studio 7 .Net 2003".  After a few moments you will see three options to configure: CMAKE_INSTALL_PREFIX, XTRKCAD_USE_GTK, and XTRKCAD_USE_GTK_CAIRO.
	- Use CMAKE_INSTALL_PREFIX to control where the software will be installed.  The default "c:/Program Files/XTrkCAD" is a good choice.
	- Use XTRKCAD_USE_GETTEXT to add new locales (language translations). Choose "OFF" to use XTrackCAD's default language (English). Refer to http://www.xtrkcad.org/Wikka/Internationalization for additional information.
	- Use XTRKCAD_USE_GTK to control the user-interface back-end.  Choose "OFF" for Windows, "ON" for all other platforms.
	- Use XTRKCAD_USE_GTK_CAIRO to enable optional high-quality antialiased Cairo rendering for the GTK back-end.  This option has no effect unless you are using the GTK back-end.
	- If you made any changes, press the "Configure" button again to update your new configuration.
	- Once everything is configured to your satisfaction, press the "OK" button to generate project files for your build.
	- Compile XTrackCad using the new project files.  For example, start MSVC and open the "XTrkCAD.sln" solution file which is located in your build directory.
	- Build the "BUILD_ALL" project to build the software.
	- Build the "INSTALL" project to install the software.
	- Run XTrackCAD by double-clicking its icon located in the install directory - for example: c:/Program Files/XTrkCAD/bin/xtrkcad.exe.

=====Notes=====

	- With some minor changes to the GTK back-end (there are a few places where the code is X11-specific), GTK / Cairo could be used on Windows for high-quality rendering (which is why the XTRKCAD_USE_GTK and XTRKCAD_USE_GTK_CAIRO options are available on Windows).

CategoryDevel