README.md

   1 # WinMerge Source Code
   2
   3 Source code for the WinMerge program, its plugins, filters, setup program,
   4 and various utilities are all kept in various subfolders listed below.
   5
   6 Changelog file is in `Docs/Users/ChangeLog.txt` and it logs user-visible
   7 or otherwise significant changes.
   8
   9 Subfolders include:
  10
  11  - `Docs`
  12    Both user and developer documentation, in different subfolders.
  13    Can be browsed by opening `index.html` in `Docs` folder.
  14
  15  - `Src`
  16    Source code to the WinMerge program itself.
  17
  18  - `Plugins`
  19    Source code and binaries for WinMerge runtime plugin dlls & scripts
  20
  21  - `Filters`
  22    WinMerge file filters which are shipped with the distribution.
  23
  24  - `ArchiveSupport`
  25    Source code for the Merge7z dlls, which connect WinMerge with 7-Zip
  26    Also this folder is required to compile `WinMergeU.exe`. There
  27    is also standalone installer for Merge7z dlls.
  28
  29  - `Externals`
  30    This folder contains several libraries whose sources come from
  31    outside WinMerge project. They are stored here for convenience for
  32    building and possible needed small changes for WinMerge. Libraries
  33    include XML parser and regular expression parser.
  34
  35  - `Installer`
  36    Installer for WinMerge.
  37
  38  - `Tools`
  39    Various utilities used by WinMerge developers; see readme files in each.
  40
  41  - `ShellExtension`
  42    Windows Shell (Explorer) integration. Adds menuitems to Explorer context
  43    menu for comparing files and folders.
  44
  45  - `Testing`
  46    A suite of test diff files and a script to run them and report the results.
  47    This folder also has `Google Test` subfolder containing unit tests made
  48    with [Google Test Framework](https://github.com/google/googletest).
  49
  50  - `Build`
  51    This folder gets created by compiler when WinMerge is compiled. It
  52    contains compiled executables, libraries, user manual etc.
  53
  54  - `BuildTmp`
  55    This folder gets created by compiler when WinMerge is compiled. It
  56    contains temporary files created during the compilation and can be safely
  57    removed.