From aa1832b218dff9f696af7c75ae2a8b33ebd3cf0c Mon Sep 17 00:00:00 2001 From: Viktor Hofer Date: Thu, 1 Feb 2024 16:18:59 +0100 Subject: [PATCH] Update README --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ab581e87..9f9f1437 100644 --- a/README.md +++ b/README.md @@ -182,9 +182,9 @@ The only feature currently supported is mapping of source files to the source re ## Prerequisites for .NET projects -Source Link supports classic .NET Framework projects as well as .NET SDK projects, that is projects that import `Microsoft.NET.Sdk` (e.g. like so: ``). The project may target any .NET Framework or .NET Core App/Standard version. All PDB formats are supported: Portable, Embedded and Windows PDBs. +Source Link supports classic .NET Framework projects as well as .NET SDK projects, that is projects that import `Microsoft.NET.Sdk` (e.g. like so: ``). The project may target .NET, .NET Framework or .NET Standard. All PDB formats are supported: Portable, Embedded and Windows PDBs. -[.NET Core SDK 2.1.300](https://www.microsoft.com/net/download/dotnet-core/sdk-2.1.300) or newer is required for .NET SDK projects. If building via desktop `msbuild` you'll need version 15.7 or higher. +[.NET 8 SDK](https://www.microsoft.com/net/download/dotnet/8.0) or newer is required for .NET SDK projects. If building via desktop `msbuild` you'll need version 16.0 or higher. The following features are not available in projects that do not import `Microsoft.NET.Sdk`: - Automatic inclusion of commit SHA in `AssemblyInformationalVersionAttribute`. @@ -200,8 +200,6 @@ The VC++ linker supports `/SOURCELINK` [switch](https://docs.microsoft.com/en-us ## Known issues -- `EmbedUntrackedSources` does not work in Visual Basic projects that use .NET SDK: https://github.com/dotnet/sourcelink/issues/193 (fixed in Visual Studio 2019) -- Issue when building WPF projects with `/p:ContinuousIntegrationBuild=true`: https://github.com/dotnet/sourcelink/issues/91 - Issue when building WPF projects with embedding sources on and `BaseIntermediateOutputPath` not a subdirectory of the project directory: https://github.com/dotnet/sourcelink/issues/492 ## PDB distributions @@ -222,7 +220,7 @@ Keep in mind that including PDBs in the .nupkg increases the size of the package - They do not support Windows PDBs (generated by VC++, or for managed projects that set build property `DebugType` to `full`) - They require the library to be built by newer C#/VB compiler (Visual Studio 2017 Update 9). -- The consumer of the package also needs Visual Studio 2017 Update 9 debugger. +- The consumer of the package also needs Visual Studio 2022 or newer. - Not supported by [Azure DevOps Artifacts](https://azure.microsoft.com/en-us/services/devops/artifacts) service. Consider including PDBs in the main package if it is not possible to use .snupkg for the above reasons. @@ -230,12 +228,12 @@ For managed projects, consider switching to Portable PDBs by setting `DebugType` ## Builds -Pre-release builds are available from Azure DevOps public feed: `https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet8/nuget/v3/index.json` ([browse](https://dev.azure.com/dnceng/public/_packaging?_a=feed&feed=dotnet8)). +Pre-release builds are available from Azure DevOps public feed: `https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet9/nuget/v3/index.json` ([browse](https://dev.azure.com/dnceng/public/_packaging?_a=feed&feed=dotnet9)). [![Build Status](https://dnceng.visualstudio.com/public/_apis/build/status/SourceLink%20PR?branchName=main)](https://dnceng.visualstudio.com/public/_build/latest?definitionId=297?branchName=main) ## Experience in Visual Studio -The following screenshot demonstrates debugging a NuGet package referenced by an application, with source automatically downloaded from GitHub and used by Visual Studio 2017. +The following screenshot demonstrates debugging a NuGet package referenced by an application, with source automatically downloaded from GitHub and used by Visual Studio. ![sourcelink-example](https://user-images.githubusercontent.com/2608468/39667937-10d7dabe-5076-11e8-815e-935724b3a783.PNG)