Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@NikolayPianikov
NikolayPianikov committed Jan 20, 2025
1 parent 6423ce9 commit 935593b
Show file tree
Hide file tree
Showing 13 changed files with 42 additions and 45 deletions.
29 changes: 14 additions & 15 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This repository contains the following directories and files:
πŸ“ 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
πŸ“ 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
Expand All @@ -37,35 +37,34 @@ This repository contains the following directories and files:
πŸ“„ 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 ΠΊun benchmarks:

```shell
./build.cmd benchmarks
Expand Down
29 changes: 14 additions & 15 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1063,7 +1063,7 @@ This repository contains the following directories and files:
πŸ“ 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
πŸ“ 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
Expand All @@ -1086,35 +1086,34 @@ This repository contains the following directories and files:
πŸ“„ 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 ΠΊun benchmarks:

```shell
./build.cmd benchmarks
Expand Down
2 changes: 1 addition & 1 deletion build/BenchmarksTarget.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
2 changes: 1 addition & 1 deletion build/DeployTarget.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
2 changes: 1 addition & 1 deletion build/GeneratorTarget.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion build/InstallTemplateTarget.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
2 changes: 1 addition & 1 deletion build/LibrariesTarget.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion build/PackTarget.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion build/PerformanceTestsTarget.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
2 changes: 1 addition & 1 deletion build/PublishBlazorTarget.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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");

Expand Down
2 changes: 1 addition & 1 deletion build/ReadmeTarget.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
2 changes: 1 addition & 1 deletion build/TemplateTarget.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
9 changes: 4 additions & 5 deletions readme/ContributingTemplate.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This repository contains the following directories and files:
πŸ“ 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
πŸ“ 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
Expand All @@ -37,7 +37,6 @@ This repository contains the following directories and files:
πŸ“„ 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:
Expand All @@ -46,13 +45,13 @@ The entire build logic is a regular [console .NET application](/build). You can
|----------|-------------|
$(commands)

For example:
For example, to build and test the source code generator:

```shell
./build.sh pack
./build.sh generator
```

or
or to ΠΊun benchmarks:

```shell
./build.cmd benchmarks
Expand Down

0 comments on commit 935593b

Please sign in to comment.