Update README.md

DevTeam · Jan 20, 2025 · 0d9cd5a · 0d9cd5a
1 parent 6423ce9
commit 0d9cd5a
Show file tree

Hide file tree

Showing 13 changed files with 129 additions and 132 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -7,65 +7,64 @@ Contribution prerequisites: [.NET SDK 9.0](https://dotnet.microsoft.com/en-us/do
 This repository contains the following directories and files:
 
 ```
-📁 .github                       - GitHub related files and main.yml for building using GitGub actions
-📁 .logs                         - temporary files for generating the README.md file
-📁 .run                          - configuration files for the Rider IDE
-📁 benchmarks                    - projects for performance measurement
-📁 build                         - application for building locally and using CI/CD
-📁 docs                          - resources for the README.md file
-📁 readme                        - sample scripts and examples of application implementations
-📁 samples                       - sample project
-📁 src                           - source codes of the code generator and all libraries
-|- 📂 Pure.DI                    - source code generator project
-|- 📂 Pure.DI.Abstractions       - abstraction library for Pure.DI
-|- 📂 Pure.DI.Core               - basic implementation of the source code generator
-|- 📂 Pure.DI.MS                 - project for integration with Microsoft DI
-|- 📂 Pure.DI.Templates          - project templates for creating .NET projects using Pure.DI
-|- 📄 Directory.Build.props      - common MSBUILD properties for all source code generator projects
-|- 📄 Library.props              - common MSBUILD properties for library projects such as Pure.DI.Abstractions
-📁 tests                         - contains projects for testing
-|- 📂 Pure.DI.Example            - project for testing some integration scenarios
-|- 📂 Pure.DI.IntegrationTests   - integration tests
-|- 📂 Pure.DI.Tests              - unit tests for basic functionality
-|- 📂 Pure.DI.UsageTests         - usage tests, used for examples in README.md
-|- 📄 Directory.Build.props      - common MSBUILD properties for all test projects
-📄 LICENSE                       - license file
-📄 build.cmd                     - Windows script file to run one of the build steps, see description below
-📄 build.sh                      - Linux/Mac OS script file to run one of the build steps, see description below
-📄 .space.kts                    - build file using JetBrains space actions
-📄 README.md                     - this README.md file
-📄 SECURITY.md                   - policy file for handling security bugs and vulnerabilities
-📄 Directory.Build.props         - basic MSBUILD properties for all projects
-📄 Pure.DI.sln                   - .NET solution file
-|- ...
+📁 .github                       GitHub related files and main.yml for building using GitGub actions
+📁 .logs                         temporary files for generating the README.md file
+📁 .run                          configuration files for the Rider IDE
+📁 benchmarks                    projects for performance measurement
+📁 build                         application for building locally and using CI/CD
+📁 docs                          resources for the README.md file
+📁 readme                        sample scripts and examples of application implementations
+📁 samples                       sample projects
+📁 src                           source codes of the code generator and all libraries
+|- 📂 Pure.DI                    source code generator project
+|- 📂 Pure.DI.Abstractions       abstraction library for Pure.DI
+|- 📂 Pure.DI.Core               basic implementation of the source code generator
+|- 📂 Pure.DI.MS                 project for integration with Microsoft DI
+|- 📂 Pure.DI.Templates          project templates for creating .NET projects using Pure.DI
+|- 📄 Directory.Build.props      common MSBUILD properties for all source code generator projects
+|- 📄 Library.props              common MSBUILD properties for library projects such as Pure.DI.Abstractions
+📁 tests                         contains projects for testing
+|- 📂 Pure.DI.Example            project for testing some integration scenarios
+|- 📂 Pure.DI.IntegrationTests   integration tests
+|- 📂 Pure.DI.Tests              unit tests for basic functionality
+|- 📂 Pure.DI.UsageTests         usage tests, used for examples in README.md
+|- 📄 Directory.Build.props      common MSBUILD properties for all test projects
+📄 LICENSE                       license file
+📄 build.cmd                     Windows script file to run one of the build steps, see description below
+📄 build.sh                      Linux/Mac OS script file to run one of the build steps, see description below
+📄 .space.kts                    build file using JetBrains space actions
+📄 README.md                     this README.md file
+📄 SECURITY.md                   policy file for handling security bugs and vulnerabilities
+📄 Directory.Build.props         basic MSBUILD properties for all projects
+📄 Pure.DI.sln                   .NET solution file
 ```
 
 The entire build logic is a regular [console .NET application](/build). You can use the [build.cmd](/build.cmd) and [build.sh](/build.sh) files with the appropriate command in the parameters to perform all basic actions on the project, e.g:
 
 | Commands | Description |
 |----------|-------------|
-| bm, benchmarks, benchmarks | Runs benchmarks |
+| bm, benchmarks, benchmarks | Run benchmarks |
 | c, check, check | Compatibility checks |
-| dp, deploy, deploy | Deploys packages |
+| dp, deploy, deploy | Package deployment |
 | e, example, example | Create examples |
-| g, generator, generator | Builds and tests generator |
-| i, install, install | Install template |
-| l, libs, libs | Builds and tests libraries |
-| p, pack, pack | Creates NuGet packages |
-| perf, performance, performance | Runs performance tests |
-| pb, publish, publish | Publish balazor web sssembly example |
-| r, readme, readme | Generates README.md |
-| t, template, template | Creates and deploys template |
+| g, generator, generator | Build and test the source code generator |
+| i, install, install | Install templates |
+| l, libs, libs | Build and test libraries |
+| p, pack, pack | Create NuGet packages |
+| perf, performance, performance | Performance tests |
+| pb, publish, publish | Publish the balazor web sssembly example |
+| r, readme, readme | Generate README.md |
+| t, template, template | Create and deploy templates |
 | te, testexamples, testexamples | Test examples |
 | u, upgrade, upgrade | Upgrading the internal version of DI to the latest public version |
 
-For example:
+For example, to build and test the source code generator: 
 
 ```shell
-./build.sh pack
+./build.sh generator
 ```
 
-or
+or to run benchmarks:
 
 ```shell
 ./build.cmd benchmarks

diff --git a/README.md b/README.md
@@ -1056,65 +1056,64 @@ Contribution prerequisites: [.NET SDK 9.0](https://dotnet.microsoft.com/en-us/do
 This repository contains the following directories and files:
 
 ```
-📁 .github                       - GitHub related files and main.yml for building using GitGub actions
-📁 .logs                         - temporary files for generating the README.md file
-📁 .run                          - configuration files for the Rider IDE
-📁 benchmarks                    - projects for performance measurement
-📁 build                         - application for building locally and using CI/CD
-📁 docs                          - resources for the README.md file
-📁 readme                        - sample scripts and examples of application implementations
-📁 samples                       - sample project
-📁 src                           - source codes of the code generator and all libraries
-|- 📂 Pure.DI                    - source code generator project
-|- 📂 Pure.DI.Abstractions       - abstraction library for Pure.DI
-|- 📂 Pure.DI.Core               - basic implementation of the source code generator
-|- 📂 Pure.DI.MS                 - project for integration with Microsoft DI
-|- 📂 Pure.DI.Templates          - project templates for creating .NET projects using Pure.DI
-|- 📄 Directory.Build.props      - common MSBUILD properties for all source code generator projects
-|- 📄 Library.props              - common MSBUILD properties for library projects such as Pure.DI.Abstractions
-📁 tests                         - contains projects for testing
-|- 📂 Pure.DI.Example            - project for testing some integration scenarios
-|- 📂 Pure.DI.IntegrationTests   - integration tests
-|- 📂 Pure.DI.Tests              - unit tests for basic functionality
-|- 📂 Pure.DI.UsageTests         - usage tests, used for examples in README.md
-|- 📄 Directory.Build.props      - common MSBUILD properties for all test projects
-📄 LICENSE                       - license file
-📄 build.cmd                     - Windows script file to run one of the build steps, see description below
-📄 build.sh                      - Linux/Mac OS script file to run one of the build steps, see description below
-📄 .space.kts                    - build file using JetBrains space actions
-📄 README.md                     - this README.md file
-📄 SECURITY.md                   - policy file for handling security bugs and vulnerabilities
-📄 Directory.Build.props         - basic MSBUILD properties for all projects
-📄 Pure.DI.sln                   - .NET solution file
-|- ...
+📁 .github                       GitHub related files and main.yml for building using GitGub actions
+📁 .logs                         temporary files for generating the README.md file
+📁 .run                          configuration files for the Rider IDE
+📁 benchmarks                    projects for performance measurement
+📁 build                         application for building locally and using CI/CD
+📁 docs                          resources for the README.md file
+📁 readme                        sample scripts and examples of application implementations
+📁 samples                       sample projects
+📁 src                           source codes of the code generator and all libraries
+|- 📂 Pure.DI                    source code generator project
+|- 📂 Pure.DI.Abstractions       abstraction library for Pure.DI
+|- 📂 Pure.DI.Core               basic implementation of the source code generator
+|- 📂 Pure.DI.MS                 project for integration with Microsoft DI
+|- 📂 Pure.DI.Templates          project templates for creating .NET projects using Pure.DI
+|- 📄 Directory.Build.props      common MSBUILD properties for all source code generator projects
+|- 📄 Library.props              common MSBUILD properties for library projects such as Pure.DI.Abstractions
+📁 tests                         contains projects for testing
+|- 📂 Pure.DI.Example            project for testing some integration scenarios
+|- 📂 Pure.DI.IntegrationTests   integration tests
+|- 📂 Pure.DI.Tests              unit tests for basic functionality
+|- 📂 Pure.DI.UsageTests         usage tests, used for examples in README.md
+|- 📄 Directory.Build.props      common MSBUILD properties for all test projects
+📄 LICENSE                       license file
+📄 build.cmd                     Windows script file to run one of the build steps, see description below
+📄 build.sh                      Linux/Mac OS script file to run one of the build steps, see description below
+📄 .space.kts                    build file using JetBrains space actions
+📄 README.md                     this README.md file
+📄 SECURITY.md                   policy file for handling security bugs and vulnerabilities
+📄 Directory.Build.props         basic MSBUILD properties for all projects
+📄 Pure.DI.sln                   .NET solution file
 ```
 
 The entire build logic is a regular [console .NET application](/build). You can use the [build.cmd](/build.cmd) and [build.sh](/build.sh) files with the appropriate command in the parameters to perform all basic actions on the project, e.g:
 
 | Commands | Description |
 |----------|-------------|
-| bm, benchmarks, benchmarks | Runs benchmarks |
+| bm, benchmarks, benchmarks | Run benchmarks |
 | c, check, check | Compatibility checks |
-| dp, deploy, deploy | Deploys packages |
+| dp, deploy, deploy | Package deployment |
 | e, example, example | Create examples |
-| g, generator, generator | Builds and tests generator |
-| i, install, install | Install template |
-| l, libs, libs | Builds and tests libraries |
-| p, pack, pack | Creates NuGet packages |
-| perf, performance, performance | Runs performance tests |
-| pb, publish, publish | Publish balazor web sssembly example |
-| r, readme, readme | Generates README.md |
-| t, template, template | Creates and deploys template |
+| g, generator, generator | Build and test the source code generator |
+| i, install, install | Install templates |
+| l, libs, libs | Build and test libraries |
+| p, pack, pack | Create NuGet packages |
+| perf, performance, performance | Performance tests |
+| pb, publish, publish | Publish the balazor web sssembly example |
+| r, readme, readme | Generate README.md |
+| t, template, template | Create and deploy templates |
 | te, testexamples, testexamples | Test examples |
 | u, upgrade, upgrade | Upgrading the internal version of DI to the latest public version |
 
-For example:
+For example, to build and test the source code generator: 
 
 ```shell
-./build.sh pack
+./build.sh generator
 ```
 
-or
+or to run benchmarks:
 
 ```shell
 ./build.cmd benchmarks

diff --git a/build/BenchmarksTarget.cs b/build/BenchmarksTarget.cs
@@ -13,7 +13,7 @@ internal class BenchmarksTarget(
     private static readonly string[] Filters = ["Pure.DI.Benchmarks.Benchmarks.*"];
 
     public Task InitializeAsync(CancellationToken cancellationToken) => commands.RegisterAsync(
-        this, "Runs benchmarks", "benchmarks", "bm");
+        this, "Run benchmarks", "benchmarks", "bm");
 
     public async Task<int> RunAsync(CancellationToken cancellationToken)
     {

diff --git a/build/DeployTarget.cs b/build/DeployTarget.cs
@@ -9,7 +9,7 @@ internal class DeployTarget(
     : IInitializable, ITarget<int>
 {
     public Task InitializeAsync(CancellationToken cancellationToken) => commands.RegisterAsync(
-        this, "Deploys packages", "deploy", "dp");
+        this, "Package deployment", "deploy", "dp");
 
     public async Task<int> RunAsync(CancellationToken cancellationToken)
     {

diff --git a/build/GeneratorTarget.cs b/build/GeneratorTarget.cs
@@ -13,7 +13,7 @@ internal class GeneratorTarget(
     private string PackageName => $"Pure.DI.{settings.NextVersion}.nupkg";
 
     public Task InitializeAsync(CancellationToken cancellationToken) => commands.RegisterAsync(
-        this, "Builds and tests generator", "generator", "g");
+        this, "Build and test the source code generator", "generator", "g");
 
     [SuppressMessage("Performance", "CA1861:Avoid constant arrays as arguments")]
     public async Task<Package> RunAsync(CancellationToken cancellationToken)

diff --git a/build/InstallTemplateTarget.cs b/build/InstallTemplateTarget.cs
@@ -9,7 +9,7 @@ internal class InstallTemplateTarget(
     : IInitializable, ITarget<Package>
 {
     public Task InitializeAsync(CancellationToken cancellationToken) => commands.RegisterAsync(
-        this, "Install template", "install", "i");
+        this, "Install templates", "install", "i");
 
     public async Task<Package> RunAsync(CancellationToken cancellationToken)
     {

diff --git a/build/LibrariesTarget.cs b/build/LibrariesTarget.cs
@@ -16,7 +16,7 @@ internal class LibrariesTarget(
     : IInitializable, ITarget<IReadOnlyCollection<Library>>
 {
     public Task InitializeAsync(CancellationToken cancellationToken) => commands.RegisterAsync(
-        this, "Builds and tests libraries", "libs", "l");
+        this, "Build and test libraries", "libs", "l");
 
     [SuppressMessage("Performance", "CA1861:Avoid constant arrays as arguments")]
     public async Task<IReadOnlyCollection<Library>> RunAsync(CancellationToken cancellationToken)

diff --git a/build/PackTarget.cs b/build/PackTarget.cs
@@ -15,7 +15,7 @@ internal class PackTarget(
     : IInitializable, ITarget<IReadOnlyCollection<Package>>
 {
     public Task InitializeAsync(CancellationToken cancellationToken) => commands.RegisterAsync(
-        this, "Creates NuGet packages", "pack", "p");
+        this, "Create NuGet packages", "pack", "p");
 
     [SuppressMessage("Performance", "CA1861:Avoid constant arrays as arguments")]
     public async Task<IReadOnlyCollection<Package>> RunAsync(CancellationToken cancellationToken)

diff --git a/build/PerformanceTestsTarget.cs b/build/PerformanceTestsTarget.cs
@@ -20,7 +20,7 @@ internal class PerformanceTestsTarget(
     ];
 
     public Task InitializeAsync(CancellationToken cancellationToken) => commands.RegisterAsync(
-        this, "Runs performance tests", "performance", "perf");
+        this, "Performance tests", "performance", "perf");
 
     public async Task<bool> RunAsync(CancellationToken cancellationToken)
     {

diff --git a/build/PublishBlazorTarget.cs b/build/PublishBlazorTarget.cs
@@ -13,7 +13,7 @@ internal class PublishBlazorTarget(
 {
     public Task InitializeAsync(CancellationToken cancellationToken) => commands.RegisterAsync(
         this,
-        "Publish balazor web sssembly example",
+        "Publish the balazor web sssembly example",
         "publish",
         "pb");
 

diff --git a/build/ReadmeTarget.cs b/build/ReadmeTarget.cs
@@ -26,7 +26,7 @@ internal class ReadmeTarget(
     private const string ContributingFile = "CONTRIBUTING.md";
 
     public Task InitializeAsync(CancellationToken cancellationToken) => commands.RegisterAsync(
-        this, $"Generates {CommonReadmeFile}", "readme", "r");
+        this, $"Generate {CommonReadmeFile}", "readme", "r");
 
     public async Task<int> RunAsync(CancellationToken cancellationToken)
     {

diff --git a/build/TemplateTarget.cs b/build/TemplateTarget.cs
@@ -13,7 +13,7 @@ internal class TemplateTarget(
     public const string ProjectName = "Pure.DI.Templates";
 
     public Task InitializeAsync(CancellationToken cancellationToken) => commands.RegisterAsync(
-        this, "Creates and deploys template", "template", "t");
+        this, "Create and deploy templates", "template", "t");
 
     public async Task<Package> RunAsync(CancellationToken cancellationToken)
     {