build.txt

   1 Build instructions\r
   2 ==================\r
   3 \r
   4 Compiling TortoiseGit is not very difficult, but it requires several steps\r
   5 to finish, at least the first time.\r
   6 \r
   7 Unlike other big open source projects, once you have built all the libraries\r
   8 TortoiseGit depends on, you can use the familiar Visual Studio IDE to build\r
   9 and debug the binaries. No need to run the build script for every little change.\r
  10 \r
  11 So don't give up if you read through the next section and all the requirements.\r
  12 You only have to do this once.\r
  13 \r
  14 Requirements\r
  15 ------------\r
  16 \r
  17 First, you need to install the compiler package:\r
  18 \r
  19 *  You need at least Visual Studio 2013 for\r
  20    building the full TortoiseGit package.\r
  21    The TortoiseGit teams uses VS2013 Professional Update 5.\r
  22    Make sure the "Microsoft Foundation Classes for C++" are installed.\r
  23    This is the recommended option, but it is not free :-(\r
  24 \r
  25    If you do not have access to VS Professional you can download the free\r
  26    Visual Studio Community 2013 Edition (https://www.visualstudio.com/en-us/news/vs2013-community-vs).\r
  27    This version also allows to fully build the TortoiseGit package if\r
  28    "Microsoft Foundation Classes for C++" are selected.\r
  29 \r
  30 Next you might need to install some utilities/programs:\r
  31 *  If you want to build the MSI installer you need WiX3.9 (http://wix.codeplex.com/)\r
  32 *  For building the docs you need NAnt (http://nant.sourceforge.net/) and\r
  33    https://sourceforge.net/projects/tortoisesvn/files/build%20tools/\r
  34    See doc/readme.txt for more details on building the docs.\r
  35 *  If you want to execute the unit tests from within VisualStudio the GoogleTestAdaper is recommended\r
  36    (https://github.com/csoltenborn/GoogleTestAdapter/releases)\r
  37 \r
  38 Get external source code\r
  39 ------------------------\r
  40 \r
  41 TortoiseGit comes with all required code in its repository included or linked as submodules:\r
  42 \r
  43 Run\r
  44 \r
  45     git submodule update --init\r
  46 \r
  47 to download all linked repositories (submodules) automatically.\r
  48 Alternatively, you can download submodules when cloning the main project with single command.\r
  49 \r
  50     git clone --recursive https://gitlab.com/tortoisegit/tortoisegit.git\r
  51 \r
  52 Building the packages\r
  53 ---------------------\r
  54 \r
  55 Open TortoiseGit.sln in Visual Studio.\r
  56 Build all projects.\r
  57 \r
  58 You can also build TortoiseGit via command line by calling MSBuild 4.0.\r
  59 Open Developer Command Prompt for VS2013\r
  60 \r
  61     MSBuild TortoiseGit.sln /p:Configuration=Release;Platform=Win32\r
  62     MSBuild TortoiseGit.sln /p:Configuration=Release;Platform=x64\r
  63 \r
  64 If you want to build the installer package, make sure you build the Win32 configuration before the x64 one\r
  65 Also, build the docs before the installer packages (or copy existing TortoiseGit_en.chm and TortoiseMerge_en.chm files into the doc/output folder).\r
  66 \r
  67 For optimized debugging copy TGitNatVis.dll and TortoiseGit.natvis from contrib\NatVis to %USERPROFILE%\Documents\Visual Studio 2013\Visualizers.\r
  68 Then CGitHash will provide a readable preview of the SHA-1 and CTGitPath is also optimized.\r