Skip to content

Commit

Permalink
Fix README.md for new updates on image compare.
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisRega committed May 5, 2024
1 parent e7b4f42 commit f8efb40
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,9 +145,8 @@ rules:

#### Image comparison

Image comparison is done using the `image compare` crate's hybrid comparison which does MSSIM on the luma and RMS on the
color information.
Only a threshold can be specified:
Image comparison is done using the `image compare` crate.
Specify loads of options here and then filter on threshold.

```yaml
rules:
Expand All @@ -156,8 +155,9 @@ rules:
- "**/*.jpg"
# exclude can of course also be specified!
Image:
# threshold is between 0.0 for total difference, 0.5 for very dissimilar and 1.0 for perfect mach
# Usually you want to test with values between 0.90 and 0.97
# Compare images in RGBA-mode, can also be RGB and Gray
# Comparison mode set to Hybrid means we want MSSIM on the Y channel and 2 dim vec diff on UV for color information
RGBA: Hybrid
threshold: 0.9
```

Expand Down Expand Up @@ -307,7 +307,8 @@ rules:

### 0.6.0

- Add new options for image compare module (loads!)
- Add new options for image compare module (a lot of options!)
- Bump json-compare to new version fixing bugs in regex field excludes and sorting

### 0.5.4

Expand Down

0 comments on commit f8efb40

Please sign in to comment.