README.md

   1 # WinMerge Source Code
   2
   3 [WinMerge](http://winmerge.org/) is an Open Source differencing and merging tool
   4 for Windows. WinMerge can compare both folders and files, presenting differences
   5 in a visual text format that is easy to understand and handle.
   6
   7 ## Requirements
   8
   9 ### Visual Studio 2017
  10
  11  * *Community*, *Professional* or *Enterprise* Edition
  12  * VC++ 2017 v141 toolset
  13  * Windows XP support for C++
  14  * MFC and ATL support
  15  * Windows 10 SDK
  16
  17 ### Visual Studio 2019
  18
  19  * *Community*, *Professional* or *Enterprise* Edition
  20  * MSVC v142 Buildtools
  21  * C++ MFC for v142 Buildtools
  22  * Windows 10 SDK
  23
  24 ## Folder Structure
  25
  26 Source code for the WinMerge program, its plugins, filters, setup program,
  27 and various utilities are all kept in various subfolders listed below.
  28
  29 Changelog file is in `Docs/Users/ChangeLog.txt` and it logs user-visible
  30 or otherwise significant changes.
  31
  32 Subfolders include:
  33
  34  - `Docs`
  35    Both user and developer documentation, in different subfolders.
  36    Can be browsed by opening `index.html` in `Docs` folder.
  37
  38  - `Src`
  39    Source code to the WinMerge program itself.
  40
  41  - `Plugins`
  42    Source code and binaries for WinMerge runtime plugin dlls & scripts
  43
  44  - `Filters`
  45    WinMerge file filters which are shipped with the distribution.
  46
  47  - `ArchiveSupport`
  48    Source code for the Merge7z dlls, which connect WinMerge with 7-Zip
  49    Also this folder is required to compile `WinMergeU.exe`. There
  50    is also standalone installer for Merge7z dlls.
  51
  52  - `Externals`
  53    This folder contains several libraries whose sources come from
  54    outside WinMerge project. They are stored here for convenience for
  55    building and possible needed small changes for WinMerge. Libraries
  56    include XML parser and regular expression parser.
  57
  58  - `Installer`
  59    Installer for WinMerge.
  60
  61  - `Tools`
  62    Various utilities used by WinMerge developers; see readme files in each.
  63
  64  - `ShellExtension`
  65    Windows Shell (Explorer) integration. Adds menuitems to Explorer context
  66    menu for comparing files and folders.
  67
  68  - `Testing`
  69    A suite of test diff files and a script to run them and report the results.
  70    This folder also has `Google Test` subfolder containing unit tests made
  71    with [Google Test Framework](https://github.com/google/googletest).
  72
  73  - `Build`
  74    This folder gets created by compiler when WinMerge is compiled. It
  75    contains compiled executables, libraries, user manual etc.
  76
  77  - `BuildTmp`
  78    This folder gets created by compiler when WinMerge is compiled. It
  79    contains temporary files created during the compilation and can be safely
  80    removed.