Skip to content

Commit 479cd3d

Browse files
Update README.md
1 parent 38636d9 commit 479cd3d

File tree

2 files changed

+38
-24
lines changed

2 files changed

+38
-24
lines changed

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
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, 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 console cross-platform .NET application 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

@@ -16,32 +16,33 @@ C# interactive build automation system makes it easy to build .NET projects. It
1616
- [X] 3 compatible [operating modes](#operating-modes)
1717
- [X] Cross-platform
1818
- [X] Debugging capability
19-
- [X] No model limitations (Task, Target, DependsOn, etc.)
20-
- Regular .NET code
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
2121
- Best programming practices
2222
- [X] Powerful API for building .NET projects
2323
- [X] Summarised statistics
2424

2525
## Operating modes
2626

27-
- [Interactive](#interactive-repl)
28-
- [Running C# script](#running-c-script)
29-
- [Regular .NET build project](#net-build-project)
30-
31-
These modes are practically compatible, i.e., for example, a script can be run as a .NET project, and vice versa, with minimal or no changes.
27+
<details>
3228

33-
## Interactive (REPL)
29+
<summary>Interactive</summary>
3430

35-
Please see [this page](https://github.com/DevTeam/csharp-interactive/wiki/Install-the-C%23-script-template) for installation details.
31+
Please see [this page](https://www.nuget.org/packages/dotnet-csi) for installation details.
3632

3733
Launch the tool in the interactive mode:
3834

3935
```Shell
4036
dotnet csi
4137
```
38+
4239
Simply enter C# commands sequentially one line after another and get the result in console output.
4340

44-
## Running C# script
41+
</details>
42+
43+
<details>
44+
45+
<summary>Running C# script</summary>
4546

4647
Run a specified script with a given argument:
4748

@@ -84,7 +85,11 @@ Supported options:
8485

8586
</details>
8687

87-
## .NET build project
88+
</details>
89+
90+
<details>
91+
92+
<summary>.NET build project</summary>
8893

8994
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).
9095

@@ -104,6 +109,8 @@ The created project contains 2 entry points:
104109
dotnet run --project ./Build
105110
```
106111

112+
</details>
113+
107114
## NuGet packages
108115

109116
| Package name | Link | Description | Installation |

README_BODY.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
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, 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 console cross-platform .NET application 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

@@ -16,32 +16,33 @@ C# interactive build automation system makes it easy to build .NET projects. It
1616
- [X] 3 compatible [operating modes](#operating-modes)
1717
- [X] Cross-platform
1818
- [X] Debugging capability
19-
- [X] No model limitations (Task, Target, DependsOn, etc.)
20-
- Regular .NET code
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
2121
- Best programming practices
2222
- [X] Powerful API for building .NET projects
2323
- [X] Summarised statistics
2424

2525
## Operating modes
2626

27-
- [Interactive](#interactive-repl)
28-
- [Running C# script](#running-c-script)
29-
- [Regular .NET build project](#net-build-project)
30-
31-
These modes are practically compatible, i.e., for example, a script can be run as a .NET project, and vice versa, with minimal or no changes.
27+
<details>
3228

33-
## Interactive (REPL)
29+
<summary>Interactive</summary>
3430

35-
Please see [this page](https://github.com/DevTeam/csharp-interactive/wiki/Install-the-C%23-script-template) for installation details.
31+
Please see [this page](https://www.nuget.org/packages/dotnet-csi) for installation details.
3632

3733
Launch the tool in the interactive mode:
3834

3935
```Shell
4036
dotnet csi
4137
```
38+
4239
Simply enter C# commands sequentially one line after another and get the result in console output.
4340

44-
## Running C# script
41+
</details>
42+
43+
<details>
44+
45+
<summary>Running C# script</summary>
4546

4647
Run a specified script with a given argument:
4748

@@ -84,7 +85,11 @@ Supported options:
8485

8586
</details>
8687

87-
## .NET build project
88+
</details>
89+
90+
<details>
91+
92+
<summary>.NET build project</summary>
8893

8994
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).
9095

@@ -104,6 +109,8 @@ The created project contains 2 entry points:
104109
dotnet run --project ./Build
105110
```
106111

112+
</details>
113+
107114
## NuGet packages
108115

109116
| Package name | Link | Description | Installation |

0 commit comments

Comments
 (0)