Skip to content

Add troubleshooting section for System.Drawing.Common warnings in README #669

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
Shane32 merged 4 commits into from
Oct 10, 2025
Merged

Add troubleshooting section for System.Drawing.Common warnings in README #669

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8e81d36
Add troubleshooting section for System.Drawing.Common warnings in README
Shane32 Oct 10, 2025
ba6554c
Update troubleshooting section header to use warning emoji
Shane32 Oct 10, 2025
0f2f99f
Clarify solutions for System.Drawing.Common platform compatibility in…
Shane32 Oct 10, 2025
dd0053a
Apply suggestion from @Shane32
Shane32 Oct 10, 2025
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
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,27 @@ for (int y = 0; y < size; y++)
}
```

## ⚠️ Troubleshooting

### System.Drawing.Common Warnings (QRCode and ArtQRCode renderers)

The `QRCode` and `ArtQRCode` renderers depend on `System.Drawing.Common`, which Microsoft has [removed cross-platform support for in .NET 6+](https://learn.microsoft.com/en-us/dotnet/core/compatibility/core-libraries/6.0/system-drawing-common-windows-only). You may encounter one of the following build or runtime errors:

```
CA1416: This call site is reachable on all platforms. 'QRCode.QRCode(QRCodeData)' is only supported on: 'windows'

System.TypeInitializationException: The type initializer for 'Gdip' threw an exception.

System.PlatformNotSupportedException: System.Drawing.Common is not supported on this platform.
```

Solutions include:

1. Use Windows-specific TFMs such as `<TargetFramework>net8.0-windows</TargetFramework>`
2. Mark methods with the `[SupportedOSPlatform("windows")]` attribute
3. Add platform guards by wrapping code with `#if WINDOWS` or `if (OperatingSystem.IsWindows())`
4. Use cross-platform renderers such as `PngByteQRCode`, `SvgQRCode`, or `BitmapByteQRCode`

## 🚀 CI Builds

The NuGet feed contains only **major/stable** releases. If you want the latest functions and features, you can use the CI builds [via Github packages](https://github.com/Shane32/qrcoder/packages).
Expand Down