Skip to content

Readme update #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stesee merged 5 commits into from
May 13, 2026
+10 −0
Merged

Readme update #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
81ddbf8
Update README with licensing note for ImageSharp dependency and ignor…
stesee May 13, 2026
63a404d
Fix typo in README regarding SkiaSharp.Compare alternative
stesee May 13, 2026
cc2f7db
Add detailed ImageSharp license note and alternative suggestion to RE…
stesee May 13, 2026
367b48d
Fix wording in ImageSharp license note for clarity
stesee May 13, 2026
10b909d
Potential fix for pull request finding
stesee May 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/dotnet.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ env:

on:
push:
paths-ignore:
- '**/*.md'

jobs:
build:
Expand Down
4 changes: 4 additions & 0 deletions ImageSharpCompare/docs/nugetReadme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ Compares images
Supports comparing images by using a tolerance mask image.
Linux, Windows, MacOs supported.

## ImageSharp License Note

If you run into the licensing hassle around the ImageSharp dependency, consider [Codeuctivity/SkiaSharp.Compare](https://github.com/Codeuctivity/SkiaSharp.Compare) as an alternative. It is semi API compatible, and if that project already satisfies your personal needs, it may also be the better fit for you. For further details, see [Licence Enforcement Changes](https://sixlabors.com/posts/licence-enforcement-changes/). The respect here is directed toward the ImageSharp dependency and the work behind it. Keeping this project compliant with license changes takes ongoing effort, and [funding](https://github.com/sponsors/Codeuctivity) would help make it easier to upgrade to the latest ImageSharp versions and keep pace with their technical changes responsibly.

Basic example:

```csharp
Expand Down
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ Inspired by the image compare feature "Visual verification API" of [TestApi](htt

ImageSharpCompare focus on os agnostic support and therefore depends on [SixLabors.ImageSharp](https://github.com/SixLabors/ImageSharp).

## ImageSharp License Note

If you run into the licensing hassle around the ImageSharp dependency, consider [Codeuctivity/SkiaSharp.Compare](https://github.com/Codeuctivity/SkiaSharp.Compare) as an alternative. It is semi API compatible, and satisfies my personal needs, it may also be the better fit for you. For further details, see [Licence Enforcement Changes](https://sixlabors.com/posts/licence-enforcement-changes/). The respect here is directed toward the ImageSharp dependency and the work behind it. Keeping this project compliant with license changes takes ongoing effort, and [funding](https://github.com/sponsors/Codeuctivity) would help make it easier to upgrade to the latest ImageSharp versions and keep pace with their technical changes responsibly.

NOTE: The Alpha-channel is ignored.

## Example simple show cases
Expand Down
Loading