Skip to content

Commit 79bc6e1

Browse files
committed
README changed
1 parent aa89542 commit 79bc6e1

File tree

2 files changed

+4
-9
lines changed

2 files changed

+4
-9
lines changed

.vscode/extensions.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
"recommendations": [
33
"mhutchie.git-graph",
44
"streetsidesoftware.code-spell-checker",
5-
"slevesque.vscode-hexdump",
65
"timonwong.shellcheck",
76
"redhat.vscode-xml",
87
"redhat.vscode-yaml"

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Compares images
44

5-
[![.github/workflows/dotnet.yml](https://github.com/Codeuctivity/ImageSharp.Compare/actions/workflows/dotnet.yml/badge.svg)](https://github.com/Codeuctivity/ImageSharp.Compare/actions/workflows/dotnet.yml) [![Nuget](https://img.shields.io/nuget/v/Codeuctivity.ImageSharpCompare.svg)](https://www.nuget.org/packages/Codeuctivity.ImageSharpCompare/) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/2fb2807a16f84021b088769e56e1515a)](https://www.codacy.com/gh/Codeuctivity/ImageSharp.Compare/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Codeuctivity/ImageSharp.Compare&utm_campaign=Badge_Grade) [![Donate](https://img.shields.io/static/v1?label=Paypal&message=Donate&color=informational)](https://www.paypal.com/donate?hosted_button_id=7M7UFMMRTS7UE)
5+
[![.github/workflows/dotnet.yml](https://github.com/Codeuctivity/ImageSharp.Compare/actions/workflows/dotnet.yml/badge.svg)](https://github.com/Codeuctivity/ImageSharp.Compare/actions/workflows/dotnet.yml) [![Nuget](https://img.shields.io/nuget/v/Codeuctivity.ImageSharpCompare.svg)](https://www.nuget.org/packages/Codeuctivity.ImageSharpCompare/) [![Donate](https://img.shields.io/static/v1?label=Paypal&message=Donate&color=informational)](https://www.paypal.com/donate?hosted_button_id=7M7UFMMRTS7UE)
66

77
Inspired by the image compare feature "Visual verification API" of [TestApi](https://blogs.msdn.microsoft.com/ivo_manolov/2009/04/20/introduction-to-testapi-part-3-visual-verification-apis/) this code supports comparing images by using a tolerance mask image. That tolerance mask image is a valid image by itself and can be manipulated.
88

@@ -16,8 +16,9 @@ ImageSharpCompare focus on os agnostic support and therefore depends on [SixLabo
1616
bool isEqual = ImageSharpCompare.ImagesAreEqual("actual.png", "expected.png");
1717
```
1818

19-
### Calculates sum of diff of all pixels
19+
### Calculates diff
2020

21+
```csharp
2122
var calcDiff = ImageSharpCompare.CalcDiff("2x2PixelBlack.png", "2x2PixelWhite.png");
2223
Console.WriteLine($"PixelErrorCount: {diff.PixelErrorCount}");
2324
Console.WriteLine($"PixelErrorPercentage: {diff.PixelErrorPercentage}");
@@ -43,7 +44,7 @@ Imagine two images you want to compare, and want to accept the found difference
4344

4445
### Tolerance mask image
4546

46-
using "compare.CalcDiff" you can calc a diff mask from actual and reference image
47+
Using **CalcDiffMaskImage** you can calc a diff mask from actual and reference image
4748

4849
Example - Create difference image
4950

@@ -61,8 +62,3 @@ Example - Compare two images using the created difference image. Add white pixel
6162
var maskedDiff = ImageSharpCompare.CalcDiff(pathPic1, pathPic2, "differenceMask.png");
6263
Assert.That(maskedDiff.AbsoluteError, Is.EqualTo(0));
6364
```
64-
65-
## .net Framework specific note / ImageSharp license note
66-
67-
.net framework (an older Windows-based .NET implementation) is supported by versions 2.x.y, caused by the used dependency ImageSharp. ImageSharp dropped .net framework support starting with version 3.
68-
ImageSharp also made a license change. You may want to stick with 2.x.y if want to avoid that caused implications.

0 commit comments

Comments
 (0)