README.md

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