OSDN Git Service

add Build and Debug Document
[tortoisegit/TortoiseGitJp.git] / build.txt
1 // To build this file, execute "nant APIDocs"\r
2 // After that, you can read the compiled version at TortoiseSVN\doc\output\TortoiseSVNAPI.chm\r
3 \r
4 /** \r
5 \page build Build instructions\r
6 \r
7 \section Introduction Introduction\r
8 Compiling TortoiseGit is not very difficult, but it requires several steps\r
9 to finish, at least the first time.\r
10 \r
11 Unlike other big open source projects, once you have built all the libraries\r
12 TortoiseGit depends on, you can use the familiar VisualStudio IDE to build\r
13 and debug the binaries. No need to run the build script for every little change.\r
14 \r
15 So don't give up if you read through the next section and all the requirements.\r
16 You only have to do this once.\r
17 \r
18 \section Requirements Requirements\r
19 \r
20 \subsection Requirements1 First, you need to install the compiler package.\r
21 \r
22 -# You need VS2008 with SP1 (or at least Visual C++ 2008) to allow\r
23    building of the full TortoiseGitpackage. \r
24    If you don't have the SP1 installed for VS2008, you will also need the\r
25    MFC feature pack for VS2008 which is available from here: \r
26    http://www.microsoft.com/downloads/details.aspx?FamilyId=D466226B-8DAB-445F-A7B4-448B326C48E7&displaylang=en\r
27    This is the recommended option, but it is not free :-(\r
28    If you want to build the msi make sure the "Tools for Redistributing\r
29    Applications" are installed.\r
30 -# If you do not have access to VS.NET you can download the free\r
31    Visual C++ 2008 Express Edition.\r
32    This will allow you to build the subversion libraries and the\r
33    SubWCRev, TortoiseBlame, TortoiseUDiff, TortoiseIDiff, CrashRpt\r
34    and ResText projects only. You can not build the main parts of\r
35    TortoiseGit(shell extension, TortoiseProc, TSVNCache, TortoiseMerge)\r
36    with the Express Edition!\r
37    - Install Visual C++ 2008 Express Edition.\r
38      Download it from http://msdn.microsoft.com/vstudio/express/visualc/\r
39    - Install MASM 6.15 from: http://win32assembly.online.fr/files/masm615.zip\r
40      and add it to the PATH environment variable\r
41    \note Do not bother to install WiX and Votive as you cannot build very much.\r
42 -# If you plan to build 64 bit packages, install the package \r
43    - "Language Tools" -> "Visual C++" -> "X64 Compilers and Tools" \r
44      available in the VS.NET2008 Professional and higher. \r
45      This will provide you with a cross-compiler and a suitable \r
46      command shell. On XP64, there will also be a native compiler.\r
47 -# \b Optional but recommended: Install Microsoft SDK for Windows Vista (February 2007 Update)\r
48    - http://www.microsoft.com/downloads/details.aspx?FamilyID=FF6467E6-5BBA-4BF5-B562-9199BE864D29 .\r
49      Make sure you install the x64 compiler, header and libraries if you want to build in x64.\r
50    - Open "Microsoft Windows SDK", "Visual Studio Registration", "Integrate Windows SDK with Visual Studio 2008"\r
51      to make sure Visual Studio uses the latest SDK headers and libraries.\r
52 -# \b Optional: Install the MSDN Library (documentation) from\r
53    http://www.microsoft.com/downloads/details.aspx?familyid=B8704100-0127-4D88-9B5D-896B9B388313\r
54    You can always access it online at http://msdn2.microsoft.com/en-us/Library\r
55 \r
56 \subsection Requirements2 Next you need to install some utilities/programs.\r
57 - WiX(\b 1)                   http://wix.sourceforge.net\r
58 .\r
59 (\b 1) Above 3.0 version\r
60 \r
61 \section build32 Building 32 bit packages\r
62 \r
63 Open TortoiseGit.sln\r
64 Build TortoiseProc\r
65 BUild TortoiseShell\r
66 Build TortoiseUDiff\r
67 \r
68 \section Create MSI Package\r
69 \r
70 Before create MSI Package, you need build tortoisegit release version.\r
71 \r
72 Then\r
73 Build WixSetup\r
74 \r
75 \r
76 */\r