diff --git a/tools/auto-tester/README.md b/tools/auto-tester/README.md index 12056ba4c5..6a45f7a7fa 100644 --- a/tools/auto-tester/README.md +++ b/tools/auto-tester/README.md @@ -10,8 +10,11 @@ Auto-tester has 4 functions, separated into 4 tabs: 2. Evaluating the results of running tests 3. TestRail interface 4. Windows task bar utility (Windows only) - - +## Installation +1. Download the installer by browsing to [here](). +2. Double click on the installer and install to a convenient location +![](./setup_7z.png) +3. To run the auto-tester, double click **auto-tester.exe**. # Create ![](./Create.PNG) @@ -100,7 +103,8 @@ Evaluation proceeds in a number of steps: 1. The images are then pair-wise compared, using the SSIM algorithm. A fixed threshold is used to define a mismatch. -1. In interactive mode - a window is opened showing the expected image, actual image, difference image and error. +1. In interactive mode - a window is opened showing the expected image, actual image, difference image and error: +![](./autoTesterMismatchExample.png) 1. If not in interactive mode, or the user has defined the results as an error, an error is written into the error folder. The error itself is a folder with the 3 images and a small text file containing details. diff --git a/tools/auto-tester/autoTesterMismatchExample.PNG b/tools/auto-tester/autoTesterMismatchExample.PNG new file mode 100644 index 0000000000..ddabd2ed7f Binary files /dev/null and b/tools/auto-tester/autoTesterMismatchExample.PNG differ diff --git a/tools/auto-tester/setup_7z.PNG b/tools/auto-tester/setup_7z.PNG new file mode 100644 index 0000000000..aae4123cdf Binary files /dev/null and b/tools/auto-tester/setup_7z.PNG differ