diff --git a/README.md b/README.md index ccba3ec..37d265f 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,30 @@ # StyleChecker -StyleChecker is yet another code style checker and refactoring tool like -[FxCopAnalyzers][fxcopanalyzers], -[StyleCop Analyzers][stylecopanalyzers], -[SonarLint][sonarlint], -[Roslynator][roslynator], -and so on. It uses -[the .NET Compiler Platform ("Roslyn")](https://github.com/dotnet/roslyn) -to analyze the C# source code of .NET Core projects and outputs diagnostics -of a rule violation, -and when running with Visual Studio it provides code fixes as much as possible. -Note that StyleChecker contains only supplemental or niche analyzers, -so it is intended to be used together with other Roslyn analyzers. +StyleChecker is another code style checking and refactoring tool similar to +[FxCopAnalyzers][fxcopanalyzers], [StyleCop Analyzers][stylecopanalyzers], +[SonarLint][sonarlint], [Roslynator][roslynator], etc. It uses the +[.NET Compiler Platform ("Roslyn")][roslyn] to analyze the C# source code of +.NET projects and outputs diagnostics of rule violations. And when used with +IDEs such as Visual Studio, it provides as many code fixes as possible. Note +that you should use this tool with other Roslyn analyzers, as it contains only +complementary or niche analyzers. ## Get started -StyleChecker is available as -[the ![NuGet-logo][nuget-logo] NuGet package][nuget-stylechecker]. +StyleChecker is available as [the ![NuGet-logo][nuget-logo] NuGet +package][nuget-stylechecker]. ### Install StyleChecker to your project with Visual Studio 1. Open Package Manager Console. (Open your project with Visual Studio, and - select Tools - ➜ NuGet Package Manager - ➜ Package Manager Console.) + select Tools ➜ NuGet Package Manager ➜ Package Manager + Console.) 2. Enter the command `Install-Package StyleChecker` in the Package Manager Console. -### Install StyleChecker to your project with .NET Core CLI +### Install StyleChecker to your project with .NET CLI -1. Enter the command `dotnet add package StyleChecker` with the console. +- Enter the command `dotnet add package StyleChecker` with the console. ## Diagnostics @@ -37,21 +32,19 @@ See [the list of diagnostics](doc/rules). ## Customize configuration -Some analyzers can be customized to change their behaviors, -placing the configuration file `StyleChecker.xml` at the project root. -The XML Schema Definition file `config.v1.xsd` of the configuration file -and a sample of the configuration file are provided in the directory -`StyleChecker/StyleChecker/nuget/samples/` of the source tree -(or in `~/.nuget/packages/stylechecker/VERSION/samples/` -if you installed StyleChecker with the NuGet package). Note that -StyleChecker does not use the XML Schema Definition file, -but it helps you edit `StyleChecker.xml` with the text editor -that is able to validate XML documents (for example, Visual Studio IDE, -Visual Studio Code, and so on). +You can customize some analyzers to change their behaviors by placing the +configuration file `StyleChecker.xml` at the project root. The XML Schema +Definition file `config.v1.xsd` of the configuration file and a sample of the +configuration file are available in the directory +`StyleChecker/StyleChecker/nuget/samples/` of the source tree (or in +`~/.nuget/packages/stylechecker/VERSION/samples/` if you installed StyleChecker +with the NuGet package). Note that StyleChecker does not use the XML Schema +Definition file. But it helps you edit `StyleChecker.xml` with the text editor +that can validate XML documents (for example, Visual Studio IDE, Visual Studio +Code, and so on). -Create your own `StyleChecker.xml` file and place it at your project root, -and add the `AdditionalFiles` element to `.csproj` file in your project -as follows: +Create your own `StyleChecker.xml` file, place it at your project root, and add +the `AdditionalFiles` element to the `.csproj` file in your project as follows: ```xml @@ -59,14 +52,12 @@ as follows: ``` -Alternatively, with Visual Studio you can set "C# analyzer additional file" -to Build Action property (This property can be changed from -Solution Explorer -➜ Right Click on the `StyleChecker.xml` -➜ Properties -➜ Advanced -➜ Build Action). +Alternatively, in Visual Studio, you can set the value "C# analyzer additional +file" to the Build Action property. You can change this property from Solution +Explorer ➜ Right Click on the `StyleChecker.xml` ➜ Properties +➜ Advanced ➜ Build Action. +[roslyn]: https://github.com/dotnet/roslyn [fxcopanalyzers]: https://github.com/dotnet/roslyn-analyzers [stylecopanalyzers]: https://github.com/DotNetAnalyzers/StyleCopAnalyzers [sonarlint]: https://github.com/SonarSource/sonarlint-visualstudio diff --git a/StyleChecker/StyleChecker.Test/StyleChecker.Test.csproj b/StyleChecker/StyleChecker.Test/StyleChecker.Test.csproj index 6688d27..f317bab 100644 --- a/StyleChecker/StyleChecker.Test/StyleChecker.Test.csproj +++ b/StyleChecker/StyleChecker.Test/StyleChecker.Test.csproj @@ -568,8 +568,8 @@ - - + + diff --git a/StyleChecker/StyleChecker/StyleChecker.csproj b/StyleChecker/StyleChecker/StyleChecker.csproj index 3a9923b..4829447 100644 --- a/StyleChecker/StyleChecker/StyleChecker.csproj +++ b/StyleChecker/StyleChecker/StyleChecker.csproj @@ -20,12 +20,12 @@ https://maroontress.github.io/StyleChecker/ https://github.com/maroontress/StyleChecker false - StyleChecker is yet another code style checker and refactoring tool like FxCopAnalyzers, StyleCop Analyzers, SonarLint, Roslynator, and so on. + StyleChecker is another code style checking and refactoring tool similar to FxCopAnalyzers, StyleCop Analyzers, SonarLint, Roslynator, etc. See https://maroontress.github.io/StyleChecker/releasenotes.html Copyright (c) 2018 Maroontress Fast Software csharp, visual-studio, roslyn, analyzer, roslyn-analyzer, roslyn-codefix, stylechecker true - 2.1.0-beta + 2.1.0 Maroontress Fast Software README.md