Merge branch 'main' of https://github.com/VerifyTests/DiffEngine

docs/diff-tool.md

@@ -109,6 +109,8 @@ ReSharper | Options | Tools | Unit Testing | Test Runner
 
 ## Supported Tools:
 
+Tools location is automatically detected. If a tool installed in a custom location, it can be manually configured using an environment variable, that points to the executable. The environment variable format is `DiffEngine_{ToolName}`.
+
  <!-- include: diffTools. path: /src/DiffEngine.Tests/diffTools.include.md -->
 ## Non-MDI tools
 
@@ -121,6 +123,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_BeyondCompare`
   * Supported binaries: pdf, bmp, gif, ico, jpg, jpeg, png, tif, tiff, rtf
 
 #### Notes:
@@ -159,6 +162,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_DeltaWalker`
   * Supported binaries: jpg, jp2, j2k, png, gif, psd, tif, bmp, pct, pict, pic, ico, ppm, pgm, pbm, pnm, zip, jar, ear, tar, tgz, tbz2, gz, bz2, doc, docx, xls, xlsx, ppt, pdf, rtf, html, htm
 
 #### Notes:
@@ -187,6 +191,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_Diffinity`
 
 #### Notes:
 
@@ -209,6 +214,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_DiffMerge`
 
 #### Notes:
 
@@ -245,6 +251,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_ExamDiff`
 
 #### Notes:
 
@@ -268,6 +275,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_Guiffy`
   * Supported binaries: bmp, gif, jpeg, jpg, png, wbmp
 
 #### Notes:
@@ -301,6 +309,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_Kaleidoscope`
   * Supported binaries: bmp, gif, ico, jpg, jpeg, png, tiff, tif
 
 #### OSX settings:
@@ -316,6 +325,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_KDiff3`
 
 #### Notes:
 
@@ -345,6 +355,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_Neovim`
 
 #### Notes:
 
@@ -377,6 +388,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_P4Merge`
   * Supported binaries: bmp, gif, jpg, jpeg, png, pbm, pgm, ppm, tif, tiff, xbm, xpm
 
 #### Windows settings:
@@ -416,6 +428,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_Rider`
 
 #### Notes:
 
@@ -461,6 +474,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_TkDiff`
 
 #### OSX settings:
 
@@ -476,6 +490,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: False
+  * Environment variable for custom install location: `DiffEngine_TortoiseGitIDiff`
   * Supported binaries: bmp, gif, ico, jpg, jpeg, png, tif, tiff
 
 #### Windows settings:
@@ -494,6 +509,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_TortoiseGitMerge`
 
 #### Windows settings:
 
@@ -511,6 +527,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: False
+  * Environment variable for custom install location: `DiffEngine_TortoiseIDiff`
   * Supported binaries: bmp, gif, ico, jpg, jpeg, png, tif, tiff
 
 #### Windows settings:
@@ -529,6 +546,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: False
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_TortoiseMerge`
 
 #### Windows settings:
 
@@ -546,6 +564,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_Vim`
 
 #### Notes:
 
@@ -579,6 +598,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: False
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_WinMerge`
   * Supported binaries: bmp, cut, dds, exr, g3, gif, hdr, ico, iff, lbm, j2k, j2c, jng, jp2, jpg, jif, jpeg, jpe, jxr, wdp, hdp, koa, mng, pcd, pcx, pfm, pct, pict, pic, png, pbm, pgm, ppm, psd, ras, sgi, rgb, rgba, bw, tga, targa, tif, tiff, wap, wbmp, wbm, webp, xbm, xpm
 
 #### Notes:
@@ -609,6 +629,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: True
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_AraxisMerge`
   * Supported binaries: bmp, dib, emf, gif, jif, j2c, j2k, jp2, jpc, jpeg, jpg, jpx, pbm, pcx, pgm, png, ppm, ras, tif, tiff, tga, wmf
 
 #### Notes:
@@ -642,6 +663,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: True
   * Supports auto-refresh: False
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_CodeCompare`
 
 #### Notes:
 
@@ -663,6 +685,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: True
   * Supports auto-refresh: False
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_Meld`
 
 #### Notes:
 
@@ -700,6 +723,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: True
   * Supports auto-refresh: False
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_SublimeMerge`
 
 #### Notes:
 
@@ -736,6 +760,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: True
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_VisualStudio`
 
 #### Windows settings:
 
@@ -762,6 +787,7 @@ Non-MDI tools are preferred since it allows [DiffEngineTray](tray.md) to track a
   * Is MDI: True
   * Supports auto-refresh: True
   * Supports text files: True
+  * Environment variable for custom install location: `DiffEngine_VisualStudioCode`
 
 #### Notes: