Fixed missing documentation for overlay handlers
[TortoiseGit.git] / build.txt
blob645ff08771731c311190bb30b88856c7589e6957
1 /** \r
2 \page build Build instructions\r
3 \r
4 \section Introduction Introduction\r
5 Compiling TortoiseGit is not very difficult, but it requires several steps\r
6 to finish, at least the first time.\r
7 \r
8 Unlike other big open source projects, once you have built all the libraries\r
9 TortoiseGit depends on, you can use the familiar Visual Studio IDE to build\r
10 and debug the binaries. No need to run the build script for every little change.\r
12 So don't give up if you read through the next section and all the requirements.\r
13 You only have to do this once.\r
15 \section Requirements Requirements\r
17 \subsection Requirements1 First, you need to install the compiler package.\r
19 -# You need VS2012 Professional with Update 1 (or at least VS 2010 Professional) to allow\r
20    building of the full TortoiseGit package. \r
21    If you don't have the Update 1 installed for VS2012 you cannot build\r
22    binaries which run on Windows XP.\r
23    This is the recommended option, but it is not free :-(\r
24    If you want to build the msi make sure the "Tools for Redistributing\r
25    Applications" are installed.\r
26 -# If you do not have access to VS Professional you can download the free\r
27    Visual Studio Express 2012 for Windows Desktop.\r
28    This will allow you to build the subversion libraries and the\r
29    TortoiseGitBlame, TortoiseGitUDiff, TortoiseGitIDiff, CrashRpt\r
30    and ResText projects only. You can not build the main parts of\r
31    TortoiseGit(shell extension, TortoiseGitProc, TGitCache, TortoiseGitMerge)\r
32    with the Express Edition!\r
33    - Install Visual Studio Express 2012 for Windows Desktop.\r
34      Download it from http://www.microsoft.com/visualstudio/eng/products/visual-studio-express-for-windows-desktop\r
35    \note Do not bother to install WiX and Votive as you cannot build very much.\r
37 \subsection Requirements2 Next you need to install some utilities/programs.\r
38 - WiX3.7                   http://wix.codeplex.com/\r
39 .\r
41 \section get external source code\r
42 git submodule update --init\r
44 \section build Building the packages\r
46 Open TortoiseGit.sln\r
47 Build all projects.\r
49 If you want to build the installer package, make sure you build the Win32 configuration before the x64 one.\r
51 */\r