1 [![logo](Docs/Logos/WinMerge_logo_24bit.png)](https://github.com/WinMerge/winmerge)
5 [![Build status](https://ci.appveyor.com/api/projects/status/h3v3ap1kswi1tyyt?svg=true)](https://ci.appveyor.com/project/sdottaka/winmerge/build/artifacts)
6 [![CI](https://github.com/WinMerge/winmerge/workflows/CI/badge.svg)](https://github.com/WinMerge/winmerge/actions)
7 [![sourceforge.net downloads](https://img.shields.io/sourceforge/dt/winmerge)](https://sourceforge.net/projects/winmerge/files/)
8 [![Github Releases All](https://img.shields.io/github/downloads/winmerge/winmerge/total.svg)](https://github.com/WinMerge/winmerge/releases/latest)
9 [![Translation status](https://img.shields.io/badge/translations-36-green)](https://github.com/WinMerge/winmerge/blob/master/Translations/TranslationsStatus.md)
11 [WinMerge](https://winmerge.org/) is an open source differencing and merging tool
12 for Windows. WinMerge can compare files and folders, presenting differences
13 in a visual format that is easy to understand and manipulate.
17 ### Visual Studio 2017
19 * *Community*, *Professional* or *Enterprise* Edition
20 * VC++ 2017 latest v141 tools
21 * Visual C++ compilers and libraries for (ARM, ARM64)
22 * Windows XP support for C++
23 * Visual C++ MFC for (x86 and x64, ARM, ARM64)
24 * Visual C++ ATL for (x86 and x64, ARM, ARM64)
27 ### Visual Studio 2019
29 * *Community*, *Professional* or *Enterprise* Edition
30 * MSVC v142 - VS 2019 C++ (x64/x86, ARM, ARM64) build tools (Latest)
31 * C++ MFC for latest v142 build tools (x86 & x64, ARM, ARM64)
32 * C++ ATL for latest v142 build tools (x86 & x64, ARM, ARM64)
35 ### Visual Studio 2022
37 * *Community*, *Professional* or *Enterprise* Edition
38 * MSVC v143 Buildtools (x64/x86, ARM, ARM64)
39 * C++ MFC for latest v143 build tools (x64/x86, ARM, ARM64)
40 * C++ ATL for latest v143 build tools (x64/x86, ARM, ARM64)
43 ### Other utilities/programs
46 * Inno Setup 5.x and 6.x
54 git clone --recurse-submodules https://github.com/WinMerge/winmerge
57 BuildAll.vs2022.cmd [x86|x64|ARM|ARM64] or BuildAll.vs2019.cmd [x86|x64|ARM|ARM64] or BuildAll.vs2017.cmd [x86|x64|ARM|ARM64]
62 Source code for the WinMerge program, its plugins, filters, setup program,
63 and various utilities are all kept in the subfolders listed below.
65 The changelog file is in `Docs/Users/ChangeLog.md` and it documents
66 both user-visible and significant changes.
71 Both user and developer documentation, in different subfolders.
72 Can be browsed by opening `index.html` in the `Docs` folder.
75 Source code to the WinMerge program itself.
78 Source code and binaries for WinMerge runtime plugin dlls & scripts.
81 WinMerge file filters which are shipped with the distribution.
84 Source code for the Merge7z dlls, which connect WinMerge with 7-Zip.
85 Also this folder is required to compile `WinMergeU.exe`.
86 There is also a standalone installer for Merge7z dlls.
89 This folder contains several libraries whose sources come from
90 outside WinMerge project.
91 They are stored here for convenience for building and possibly
92 needed small changes for WinMerge.
93 Libraries include an XML parser and a regular expression parser.
96 Installer for WinMerge.
99 Various utilities used by WinMerge developers; see readme files in each.
102 Windows Shell (Explorer) integration.
103 Adds menuitems to Explorer context menu for comparing files and folders.
106 A suite of test diff files and a script to run them and report the results.
107 This folder also has a `Google Test` subfolder containing unit tests made
108 with [Google Test Framework](https://github.com/google/googletest).
111 This folder gets created by the compiler when WinMerge is compiled.
112 It contains compiled executables, libraries, the user manual, etc.
115 This folder gets created by the compiler when WinMerge is compiled.
116 It contains temporary files created during the compilation and can be
122 You will need to fork the main Winmerge repository and create a branch on that fork
124 Your new code needs to follow [Eric Allman indentation](https://en.wikipedia.org/wiki/Indentation_style#Allman_style)
126 When your code is ready for a review/merge create a pull request explaining the changes that you made
129 ## How to RUN and DEBUG
131 The winmerge folder has different Visual Studio solution files (.sln) that you can use to build, debug and run while you test your changes
133 If you have run any of the BuildAll scripts you can run WinMerge from path `\Build\X64\Release\WinMergeU.exe`
134 if your architecture is not `X64` look for any of the other folders generated after the build has finished
136 Another way to Debug, run the exe from previous step, then from VS attach to the running process.