Skip to content

Commit cf2f355

Browse files
committed
gif to readme
1 parent 6740c8c commit cf2f355

File tree

3 files changed

+7
-2
lines changed

3 files changed

+7
-2
lines changed
513 KB
Loading

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
## Unreleased
44

55
- Description to nuget package
6+
- Gif to readme showing how it works
67

78
## 0.0.5
89

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
1+
<img src=".github/unoptimized.png" alt="Alerted Snail" width="70"/>
2+
13
# Unoptimized Assembly Detector
24
[![build](https://github.com/bruno-garcia/unoptimized-assembly-detector/workflows/ci/badge.svg?branch=main)](https://github.com/bruno-garcia/unoptimized-assembly-detector/actions?query=branch%3Aci)
35
[![NuGet](https://img.shields.io/nuget/v/UnoptimizedAssemblyDetector.svg)](https://www.nuget.org/packages/UnoptimizedAssemblyDetector)
46

5-
A NuGet package that detects when assemblies compiled without the `-optimized` flag are added to a project and warns you about it.
7+
NuGet package that detects when assemblies compiled without the `-optimized` flag are added to a project and warns you about it.
68

79
## How does it work?
810

911
This project hooks into the build process and detects if any referenced assembly was [compiled in _Debug_ mode](https://github.com/dotnet/runtime/blob/b9b876ab510e98ac741f1c82f1cb4fb1cb21e3ef/src/libraries/System.Private.CoreLib/src/System/Diagnostics/DebuggableAttribute.cs#L22).
1012

13+
![UnoptimizedAssemblyDetector in action](.github/unoptimized-assembly-detected.gif)
14+
1115
### Add to your project:
1216

1317
```xml
@@ -35,4 +39,4 @@ roll back to an older version or chose another dependency.
3539
* Some of the blog posts that helped:
3640
* [Implementing and Debugging Custom MSBuild Tasks](https://ithrowexceptions.com/2020/08/04/implementing-and-debugging-custom-msbuild-tasks.html) by Matthias Koch.
3741
* [Shipping a cross-platform MSBuild task in a NuGet package](https://natemcmaster.com/blog/2017/07/05/msbuild-task-in-nuget/) by Nate MacMaster.
38-
* [Tyrrz](https://github.com/Tyrrrz) for the links and rants.
42+
* [Alexey Golub](https://github.com/Tyrrrz) for the links and rants.

0 commit comments

Comments
 (0)