Reorganize ReadMe.md #218
Reorganize ReadMe.md #218
Conversation
pavel-mikula-sonarsource
assigned pavel-mikula-sonarsource and sebastien-marichal and unassigned pavel-mikula-sonarsource
README.md
Outdated
|
|
||
| 1. Roslyn analyzer authors | ||
| - Analyzer authors will be able to use the tools during development to provide additional metadata about their rules (e.g. SonarQube severity, tags, a richer description, ...) and generate the SonarQube plugin. See below for additional notes if you are developing your analyzer and running the SDK against the generated NuGet repeatedly on the same development machine. | ||
| The SDK is compatible with analyzer targeting Roslyn from version 1.0.0 up to the version specified in [Directory.Build.props](./Directory.Build.props#L9). |
There was a problem hiding this comment.
The Directory.Build.props line is incorrect, it should the line 10:
| The SDK is compatible with analyzer targeting Roslyn from version 1.0.0 up to the version specified in [Directory.Build.props](./Directory.Build.props#L9). | |
| The SDK is compatible with analyzer targeting Roslyn from version 1.0.0 up to the version specified in [Directory.Build.props](./Directory.Build.props#L10). |
| If you want to create a jar for Roslyn analyzer that is not available from a NuGet feed (e.g. an analyzer you have created on your local machine) you can specify a package source that points at a local directory containing the *.nupkg* file created by the standard Roslyn templates. See the [NuGet docs](https://docs.nuget.org/create/hosting-your-own-nuget-feeds) for more information. | ||
|
|
||
| By default, the [NuGet.config](./RoslynPluginGenerator/NuGet.config#L16) file shipped with the RoslynSonarQubeGenerator has a local package source configured that points to `C:\LocalNugetFeed`. | ||
|
|
||
| #### NuGet packaging information | ||
| ### NuGet packaging information |
There was a problem hiding this comment.
The link about the nuget properties documentation could be updated to: https://learn.microsoft.com/en-us/nuget/reference/nuspec#required-metadata-elements
The NuGet package properties are documented here...
As well as the SQ plugin properties documentation link, which contains a typo (the > at the end).
|
|
||
| #### Generating a jar for an analyzer that is not available from a NuGet feed | ||
| ### Generating a jar for an analyzer that is not available from a NuGet feed |
There was a problem hiding this comment.
Same here, we can update the link to NuGet doc to host nuget to: https://learn.microsoft.com/en-us/nuget/hosting-packages/overview
See the NuGet docs for more information.
|
|
||
| ### Compatibility | ||
| v1.0 of the SDK generates plugins that are compatible with SonarQube v4.5.2 -> v6.7. | ||
| 1. Download the latest [released version](./releases/latest), or clone and build this repository. |
There was a problem hiding this comment.
The link here should be: https://github.com/SonarSource/sonarqube-roslyn-sdk/releases/latest.
| 1. Download the latest [released version](./releases/latest), or clone and build this repository. | |
| 1. Download the latest [released version](https://github.com/SonarSource/sonarqube-roslyn-sdk/releases/latest), or clone and build this repository. |
There was a problem hiding this comment.
It will point to that page, once merged to master. I want to repo-independend for the future.
On GH "view page", it adds a commit ID in the way, because it's not in the root of the repo (yet)
pavel-mikula-sonarsource
assigned sebastien-marichal and unassigned pavel-mikula-sonarsource
|
Improve Getting started section
Bring Getting started from TL;DR; to a visible area
Remove some expired history context