README.md

   1 [![logo](Docs/Logos/WinMerge_logo_24bit.png)](https://github.com/WinMerge/winmerge)
   2
   3
   4 # 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-35-green)](https://github.com/WinMerge/winmerge/blob/master/Translations/TranslationsStatus.md)
  10
  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.
  14
  15 ## Build Requirements
  16
  17 ### Visual Studio 2017
  18
  19  * *Community*, *Professional* or *Enterprise* Edition
  20  * VC++ 2017 v141 toolset
  21  * Windows XP support for C++
  22  * MFC and ATL support
  23  * Windows 10 SDK
  24
  25 ### Visual Studio 2019
  26
  27  * *Community*, *Professional* or *Enterprise* Edition
  28  * MSVC v142 Buildtools
  29  * C++ MFC for v142 Buildtools
  30  * Windows 10 SDK
  31
  32 ### Other utilities/programs
  33
  34  * Inno Setup 5.x and 6.x
  35  * 7-Zip
  36  * Python
  37  * Pandoc
  38
  39 ## How to Build
  40
  41 ~~~
  42 git clone https://github.com/winmerge/winmerge
  43 cd winmerge
  44 git submodule init
  45 git submodule update
  46 DownloadDeps.cmd
  47 BuildAll.vs2019.cmd  or  BuildAll.vs2017.cmd
  48 ~~~
  49
  50 ## Folder Structure
  51
  52 Source code for the WinMerge program, its plugins, filters, setup program,
  53 and various utilities are all kept in the subfolders listed below.
  54
  55 The changelog file is in `Docs/Users/ChangeLog.md` and it documents
  56 both user-visible and significant changes.
  57
  58 Subfolders include:
  59
  60  - `Docs`
  61    Both user and developer documentation, in different subfolders.
  62    Can be browsed by opening `index.html` in the `Docs` folder.
  63
  64  - `Src`
  65    Source code to the WinMerge program itself.
  66
  67  - `Plugins`
  68    Source code and binaries for WinMerge runtime plugin dlls & scripts.
  69
  70  - `Filters`
  71    WinMerge file filters which are shipped with the distribution.
  72
  73  - `ArchiveSupport`
  74    Source code for the Merge7z dlls, which connect WinMerge with 7-Zip.
  75    Also this folder is required to compile `WinMergeU.exe`.
  76    There is also a standalone installer for Merge7z dlls.
  77
  78  - `Externals`
  79    This folder contains several libraries whose sources come from
  80    outside WinMerge project.
  81    They are stored here for convenience for building and possibly
  82    needed small changes for WinMerge.
  83    Libraries include an XML parser and a regular expression parser.
  84
  85  - `Installer`
  86    Installer for WinMerge.
  87
  88  - `Tools`
  89    Various utilities used by WinMerge developers; see readme files in each.
  90
  91  - `ShellExtension`
  92    Windows Shell (Explorer) integration.
  93    Adds menuitems to Explorer context menu for comparing files and folders.
  94
  95  - `Testing`
  96    A suite of test diff files and a script to run them and report the results.
  97    This folder also has a `Google Test` subfolder containing unit tests made
  98    with [Google Test Framework](https://github.com/google/googletest).
  99
 100  - `Build`
 101    This folder gets created by the compiler when WinMerge is compiled.
 102    It contains compiled executables, libraries, the user manual, etc.
 103
 104  - `BuildTmp`
 105    This folder gets created by the compiler when WinMerge is compiled.
 106    It contains temporary files created during the compilation and can be
 107    safely deleted.
 108