Skip to content

Commit 2b03b67

Browse files
committed
Add a NuGet-specific README.
1 parent 29c4266 commit 2b03b67

4 files changed

Lines changed: 34 additions & 7 deletions

File tree

Directory.Build.props

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@
2727
With the Windows console host now supporting virtual terminal sequences, it
2828
makes little sense for console interaction to still be centered around the old
2929
Windows console host and the many limitations it had. System.Terminal provides
30-
an API centered around an emulated VT100 terminal (with various modern and
31-
widely supported extensions) and works on all desktop platforms that .NET 6+
30+
an API centered around a VT100 terminal with some extensions from later models
31+
and modern terminal emulators. It works on all desktop platforms that .NET 6+
3232
supports.</PackageDescription>
3333
<PackageLicenseExpression>ISC</PackageLicenseExpression>
3434
<PackageOutputPath>$(MSBuildThisFileDirectory)pkg/feed/</PackageOutputPath>

Directory.Build.targets

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@
2323
<PropertyGroup>
2424
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
2525
<IsTrimmable Condition="'$(OutputType)' == 'Library' and '$(DevelopmentDependency)' != 'true'">>true</IsTrimmable>
26-
<PackageReadmeFile>README.md</PackageReadmeFile>
26+
<PackageReadmeFile>PACKAGE.md</PackageReadmeFile>
2727
</PropertyGroup>
2828

2929
<ItemGroup>
30-
<None Include="$(MSBuildThisFileDirectory)README.md"
30+
<None Include="$(MSBuildThisFileDirectory)PACKAGE.md"
3131
Pack="true"
3232
PackagePath=""
3333
Visible="false" />

PACKAGE.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# System.Terminal
2+
3+
System.Terminal is a toolkit for writing terminal-based applications. It is
4+
effectively a complete replacement for System.Console.
5+
6+
With the Windows console host now supporting virtual terminal sequences, it
7+
makes little sense for console interaction to still be centered around the old
8+
Windows console host and the many limitations it had. System.Terminal provides
9+
an API centered around a [VT100 terminal](https://vt100.net) with some
10+
extensions from later models and modern terminal emulators. It works on all
11+
desktop platforms that .NET 6+ supports.
12+
13+
This project offers the following packages:
14+
15+
* [Terminal](https://www.nuget.org/packages/Terminal): Provides the core
16+
terminal API.
17+
* [Terminal.Hosting](https://www.nuget.org/packages/Terminal.Hosting): Provides
18+
the terminal hosting model.
19+
* [Terminal.Extensions](https://www.nuget.org/packages/Terminal.Extensions):
20+
Provides terminal hosting and logging for the .NET Generic Host.
21+
22+
See the
23+
[sample programs](https://github.com/alexrp/system-terminal/tree/master/src/samples)
24+
for examples of what the API can do.
25+
26+
For more information, please visit the
27+
[project page](https://github.com/alexrp/system-terminal).

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ effectively a complete replacement for System.Console.
1010
With the Windows console host now supporting virtual terminal sequences, it
1111
makes little sense for console interaction to still be centered around the old
1212
Windows console host and the many limitations it had. System.Terminal provides
13-
an API centered around an emulated [VT100 terminal](https://vt100.net) (with
14-
various modern and widely supported extensions) and works on all desktop
15-
platforms that .NET 6+ supports.
13+
an API centered around a [VT100 terminal](https://vt100.net) with some
14+
extensions from later models and modern terminal emulators. It works on all
15+
desktop platforms that .NET 6+ supports.
1616

1717
Please note that, since System.Terminal replaces a very fundamental component of
1818
the framework, the use of certain framework APIs becomes problematic. As an

0 commit comments

Comments
 (0)