Skip to content

Commit

Permalink
Merge pull request #36 from jnm2/update_readme
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
sharwell authored Oct 3, 2019
2 parents c25b73d + d1b590c commit 2563160
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,22 +36,35 @@ IL weaver for adding nullability annotations to .NET Framework and .NET Standard

```xml
<PropertyGroup>
<!-- Specifies the version of this rewriter to use -->
<TunnelVisionLabsReferenceAssemblyAnnotatorVersion>1.0.0-alpha.50</TunnelVisionLabsReferenceAssemblyAnnotatorVersion>
<!-- Specifies the version of Microsoft.NETCore.App.Ref to obtain nullability information from -->
<AnnotatedReferenceAssemblyVersion>3.0.0-preview9-19423-09</AnnotatedReferenceAssemblyVersion>
<!-- Specifies the version of this rewriter to use. -->
<TunnelVisionLabsReferenceAssemblyAnnotatorVersion>1.0.0-alpha.77</TunnelVisionLabsReferenceAssemblyAnnotatorVersion>

<!-- Specifies the version of Microsoft.NETCore.App.Ref to obtain nullability information from. -->
<AnnotatedReferenceAssemblyVersion>3.0.0</AnnotatedReferenceAssemblyVersion>

<!-- Includes the nullable attributes from dotnet/coreclr as source code with 'internal' accessibility. Set this to
false if the attributes are included from another source and/or are not needed. -->
<GenerateNullableAttributes>true</GenerateNullableAttributes>
</PropertyGroup>

<ItemGroup>
<!-- Include the necessary packages -->
<PackageReference Include="TunnelVisionLabs.ReferenceAssemblyAnnotator" Version="$(TunnelVisionLabsReferenceAssemblyAnnotatorVersion)" PrivateAssets="all" />
<PackageDownload Include="Microsoft.NETCore.App.Ref" Version="[$(AnnotatedReferenceAssemblyVersion)]" />
</ItemGroup>
```

Minimal:

```xml
<PropertyGroup>
<AnnotatedReferenceAssemblyVersion>3.0.0</AnnotatedReferenceAssemblyVersion>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="TunnelVisionLabs.ReferenceAssemblyAnnotator" Version="1.0.0-alpha.77" PrivateAssets="all" />
<PackageDownload Include="Microsoft.NETCore.App.Ref" Version="[$(AnnotatedReferenceAssemblyVersion)]" />
</ItemGroup>
```

### Configuration reference

* MSBuild properties
Expand Down

0 comments on commit 2563160

Please sign in to comment.