Skip to content

Commit cee39b3

Browse files
committed
Add NuGet installation instructions for schost to all documentation
The schost tool is published to nuget.org as SharpConsoleUI.Host but the docs only showed the from-source installation method. Add `dotnet tool install -g SharpConsoleUI.Host` as the primary install method in README.md, tools/schost/README.md, and docs/SCHOST.md.
1 parent a690506 commit cee39b3

3 files changed

Lines changed: 28 additions & 6 deletions

File tree

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,15 @@ cd MyApp && dotnet run
8282

8383
### Desktop Distribution (schost)
8484

85-
Package your app so end users can double-click to launch — no terminal knowledge required:
85+
Package your app so end users can double-click to launch — no terminal knowledge required.
86+
87+
Install schost from NuGet:
88+
89+
```bash
90+
dotnet tool install -g SharpConsoleUI.Host
91+
```
92+
93+
Then use it:
8694

8795
```bash
8896
# Initialize terminal config for your project

docs/SCHOST.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,22 +31,30 @@ This is NOT a custom rendering driver. Apps use the real terminal, real `NetCons
3131

3232
## Installation
3333

34-
schost lives in `tools/schost/` inside the ConsoleEx repository. Run it directly:
34+
Install from NuGet (recommended):
35+
36+
```bash
37+
dotnet tool install -g SharpConsoleUI.Host
38+
```
39+
40+
Then use `schost` directly from anywhere.
41+
42+
### Alternative: from source
43+
44+
If you're working from the ConsoleEx repository, you can run it directly:
3545

3646
```bash
3747
dotnet run --project tools/schost/src/schost -- <command>
3848
```
3949

40-
Or install as a global .NET tool:
50+
Or build and install locally:
4151

4252
```bash
4353
cd tools/schost
4454
dotnet pack src/schost -c Release
4555
dotnet tool install --global --add-source src/schost/nupkg SharpConsoleUI.Host
4656
```
4757

48-
Then use `schost` directly from anywhere.
49-
5058
## Quick Start
5159

5260
### New project

tools/schost/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,19 @@ A CLI tool that launches SharpConsoleUI apps in a configured terminal and packag
44

55
## Install
66

7+
From NuGet (recommended):
8+
```bash
9+
dotnet tool install -g SharpConsoleUI.Host
10+
```
11+
12+
From source:
713
```bash
814
cd tools/schost
915
dotnet pack src/schost -c Release
1016
dotnet tool install --global --add-source src/schost/nupkg SharpConsoleUI.Host
1117
```
1218

13-
Or run directly:
19+
Or run directly without installing:
1420
```bash
1521
dotnet run --project src/schost -- <command>
1622
```

0 commit comments

Comments
 (0)