Skip to content

Commit aefeb47

Browse files
Update README.md
1 parent 0a93c21 commit aefeb47

File tree

6 files changed

+56
-30
lines changed

6 files changed

+56
-30
lines changed

CSharpInteractive.Tests/CSharpInteractive.Tests.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<ItemGroup>
1111
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.13.0" />
1212
<PackageReference Include="Moq" Version="4.20.72" />
13-
<PackageReference Include="Pure.DI" Version="2.1.57">
13+
<PackageReference Include="Pure.DI" Version="2.1.58">
1414
<PrivateAssets>all</PrivateAssets>
1515
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
1616
</PackageReference>

CSharpInteractive/CSharpInteractive.Tool.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<ItemGroup>
3232
<!--<CompilerVisibleProperty Include="PureDIProfilePath" />-->
3333
<PackageReference Include="Microsoft.CodeAnalysis.Scripting" Version="4.12.0" />
34-
<PackageReference Include="Pure.DI" Version="2.1.57">
34+
<PackageReference Include="Pure.DI" Version="2.1.58">
3535
<PrivateAssets>all</PrivateAssets>
3636
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
3737
</PackageReference>

CSharpInteractive/CSharpInteractive.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
<ItemGroup>
2424
<PackageReference Include="Microsoft.CodeAnalysis.Scripting" Version="4.12.0" />
25-
<PackageReference Include="Pure.DI" Version="2.1.57">
25+
<PackageReference Include="Pure.DI" Version="2.1.58">
2626
<PrivateAssets>all</PrivateAssets>
2727
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
2828
</PackageReference>

README.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,34 @@
77

88
![](docs/CSharpInteractive.gif)
99

10-
C# interactive build automation system makes it easy to build .NET projects. It can be part of your solution as a regular console cross-platform .NET application or run C# scripts without compiling them, or even run in REPL mode - allowing you to run C# interactively.
10+
C# interactive build automation system makes it easy to build .NET projects. It can be part of your solution as a regular .NET console project or run C# scripts without compiling them, or even run in REPL mode - allowing you to run C# interactively.
1111

1212
![](docs/icon.png)
1313

14-
## Advantages
15-
16-
- [X] 3 compatible [operating modes](#operating-modes)
17-
- [X] Cross-platform
18-
- [X] Debugging capability
19-
- [X] No model limitations (no Tasks, Targets, DependsOn or other abstractions that would limit you from creating simple and cheap to maintain build scripts)
20-
- Just plain .NET code and nothing extra
21-
- Best programming practices
22-
- [X] Powerful API for building .NET projects
23-
- [X] Summarised statistics
14+
## Key Features
15+
16+
### ✔️ Three Integrated [Execution Modes](#operating-modes)
17+
Flexible interoperability between modes for diverse workflow requirements.
18+
### ✔️ Native Cross-Platform Support
19+
Seamless operation across Windows, Linux, and macOS environments.
20+
### ✔️ Debugging Support
21+
Ability to debug in “.NET build project” mode, allowing developers to efficiently identify and fix problems during the compilation and build process.
22+
### ✔️ Zero Abstraction Constraints
23+
No restrictive abstractions (e.g., Tasks, Targets, DependsOn) to limit script design:
24+
- Pure .NET codebase – no proprietary syntax or hidden layers
25+
- Adheres to industry-standard coding practices for maintainability
26+
### ✔️ Powerful API for building .NET projects
27+
Granular control over builds, tests, and deployments with streamlined project configuration.
28+
### ✔️ Summarised statistics
29+
Consolidated build statistics.
2430

2531
## Operating modes
2632

2733
<details>
2834

2935
<summary>Interactive</summary>
3036

31-
Please see [this page](https://www.nuget.org/packages/dotnet-csi) for installation details.
37+
REPL (Read-Eval-Print-Loop) interface for interactive code evaluation. Please see [this page](https://www.nuget.org/packages/dotnet-csi) for installation details.
3238

3339
Launch the tool in the interactive mode:
3440

@@ -44,6 +50,13 @@ Simply enter C# commands sequentially one line after another and get the result
4450

4551
<summary>Running C# script</summary>
4652

53+
Direct execution of C# scripts without prior compilation:
54+
- Zero-Compilation Workflow - execute .csx files directly using Roslyn scripting engines, bypassing traditional dotnet build steps for rapid iteration.
55+
- Cross-Platform Scripting
56+
- Windows - integrate with PowerShell/PowerShell Core automation pipelines
57+
- Linux/macOS - combine with bash/zsh scripts via shebang directives (#!/usr/bin/env dotnet-script)
58+
- Dependency Management - resolve NuGet packages in scripts via #r "nuget: PackageName/Version" syntax, with local cache optimization.
59+
4760
Run a specified script with a given argument:
4861

4962
```Shell
@@ -91,7 +104,7 @@ Supported options:
91104

92105
<summary>.NET build project</summary>
93106

94-
Please see [this page](https://github.com/DevTeam/csharp-interactive/wiki/Install-the-C%23-script-template) for details on how to install the [project template](https://www.nuget.org/packages/CSharpInteractive.Templates).
107+
Seamless integration into existing solutions as a standard .NET console project. Please see [this page](https://github.com/DevTeam/csharp-interactive/wiki/Install-the-C%23-script-template) for details on how to install the [project template](https://www.nuget.org/packages/CSharpInteractive.Templates).
95108

96109
Create a console project *__Build__* containing a script from the template *__build__*
97110

README_BODY.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,34 @@
77

88
![](docs/CSharpInteractive.gif)
99

10-
C# interactive build automation system makes it easy to build .NET projects. It can be part of your solution as a regular console cross-platform .NET application or run C# scripts without compiling them, or even run in REPL mode - allowing you to run C# interactively.
10+
C# interactive build automation system makes it easy to build .NET projects. It can be part of your solution as a regular .NET console project or run C# scripts without compiling them, or even run in REPL mode - allowing you to run C# interactively.
1111

1212
![](docs/icon.png)
1313

14-
## Advantages
15-
16-
- [X] 3 compatible [operating modes](#operating-modes)
17-
- [X] Cross-platform
18-
- [X] Debugging capability
19-
- [X] No model limitations (no Tasks, Targets, DependsOn or other abstractions that would limit you from creating simple and cheap to maintain build scripts)
20-
- Just plain .NET code and nothing extra
21-
- Best programming practices
22-
- [X] Powerful API for building .NET projects
23-
- [X] Summarised statistics
14+
## Key Features
15+
16+
### ✔️ Three Integrated [Execution Modes](#operating-modes)
17+
Flexible interoperability between modes for diverse workflow requirements.
18+
### ✔️ Native Cross-Platform Support
19+
Seamless operation across Windows, Linux, and macOS environments.
20+
### ✔️ Debugging Support
21+
Ability to debug in “.NET build project” mode, allowing developers to efficiently identify and fix problems during the compilation and build process.
22+
### ✔️ Zero Abstraction Constraints
23+
No restrictive abstractions (e.g., Tasks, Targets, DependsOn) to limit script design:
24+
- Pure .NET codebase – no proprietary syntax or hidden layers
25+
- Adheres to industry-standard coding practices for maintainability
26+
### ✔️ Powerful API for building .NET projects
27+
Granular control over builds, tests, and deployments with streamlined project configuration.
28+
### ✔️ Summarised statistics
29+
Consolidated build statistics.
2430

2531
## Operating modes
2632

2733
<details>
2834

2935
<summary>Interactive</summary>
3036

31-
Please see [this page](https://www.nuget.org/packages/dotnet-csi) for installation details.
37+
REPL (Read-Eval-Print-Loop) interface for interactive code evaluation. Please see [this page](https://www.nuget.org/packages/dotnet-csi) for installation details.
3238

3339
Launch the tool in the interactive mode:
3440

@@ -44,6 +50,13 @@ Simply enter C# commands sequentially one line after another and get the result
4450

4551
<summary>Running C# script</summary>
4652

53+
Direct execution of C# scripts without prior compilation:
54+
- Zero-Compilation Workflow - execute .csx files directly using Roslyn scripting engines, bypassing traditional dotnet build steps for rapid iteration.
55+
- Cross-Platform Scripting
56+
- Windows - integrate with PowerShell/PowerShell Core automation pipelines
57+
- Linux/macOS - combine with bash/zsh scripts via shebang directives (#!/usr/bin/env dotnet-script)
58+
- Dependency Management - resolve NuGet packages in scripts via #r "nuget: PackageName/Version" syntax, with local cache optimization.
59+
4760
Run a specified script with a given argument:
4861

4962
```Shell
@@ -91,7 +104,7 @@ Supported options:
91104

92105
<summary>.NET build project</summary>
93106

94-
Please see [this page](https://github.com/DevTeam/csharp-interactive/wiki/Install-the-C%23-script-template) for details on how to install the [project template](https://www.nuget.org/packages/CSharpInteractive.Templates).
107+
Seamless integration into existing solutions as a standard .NET console project. Please see [this page](https://github.com/DevTeam/csharp-interactive/wiki/Install-the-C%23-script-template) for details on how to install the [project template](https://www.nuget.org/packages/CSharpInteractive.Templates).
95108

96109
Create a console project *__Build__* containing a script from the template *__build__*
97110

TestBuild/TestBuild.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<Using Include="System.Threading.Tasks"/>
2323
<Using Include="Host" Static="True"/>
2424
<PackageReference Include="System.CommandLine" Version="2.0.0-beta4.22272.1"/>
25-
<PackageReference Include="Pure.DI" Version="2.1.57">
25+
<PackageReference Include="Pure.DI" Version="2.1.58">
2626
<PrivateAssets>all</PrivateAssets>
2727
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
2828
</PackageReference>

0 commit comments

Comments
 (0)