Skip to content

Commit 77a8c82

Browse files
alexrpalexrp
committed
Rename project from System.Terminal to Cathode.
Closes #78.
1 parent 8342561 commit 77a8c82

109 files changed

Lines changed: 287 additions & 242 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/release.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ env:
1313
DOTNET_NOLOGO: true
1414
jobs:
1515
release:
16-
if: github.repository == 'alexrp/system-terminal'
16+
if: github.repository == 'alexrp/cathode'
1717
runs-on: ubuntu-latest
1818
steps:
1919
- name: Clone repository

‎CONTRIBUTING.md‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@ document to familiarize yourself with the development process.
55

66
## Issue Tracker
77

8-
The [issue tracker](https://github.com/alexrp/system-terminal/issues) is where
9-
all bug reports and feature requests should be posted. Other community areas are
10-
not appropriate for these as issues raised there are likely to be lost or
11-
forgotten.
8+
The [issue tracker](https://github.com/alexrp/cathode/issues) is where all bug
9+
reports and feature requests should be posted. Other community areas are not
10+
appropriate for these as issues raised there are likely to be lost or forgotten.
1211

1312
Please respect the following points when posting on the issue tracker:
1413

@@ -26,9 +25,9 @@ being enacted.
2625
### Labels
2726

2827
We use labels to organize issues on the GitHub issue tracker. A full list of
29-
labels can be found [here](https://github.com/alexrp/system-terminal/labels),
30-
along with descriptions of each. Here are a few guidelines for how issue labels
31-
are to be applied:
28+
labels can be found [here](https://github.com/alexrp/cathode/labels), along with
29+
descriptions of each. Here are a few guidelines for how issue labels are to be
30+
applied:
3231

3332
* An issue should have exactly one `type` and one `state` label.
3433
* The `type` label should generally never change throughout an issue's
@@ -51,14 +50,14 @@ have its milestone changed if the initial guesstimation turned out to be
5150
inaccurate (in either direction).
5251

5352
A full list of milestones can be found
54-
[here](https://github.com/alexrp/system-terminal/milestones).
53+
[here](https://github.com/alexrp/cathode/milestones).
5554

5655
### Bug Reports
5756

5857
The ideal bug report is one that is immediately actionable by a person looking
5958
to resolve it. To that end, a bug report should include:
6059

61-
* The version of System.Terminal being used.
60+
* The version of Cathode being used.
6261
* Information about the host platform (operating system, architecture, etc).
6362
* A self-contained test case that reproduces the issue, along with instructions
6463
to trigger the issue.
@@ -92,9 +91,9 @@ feature is a welcome addition.
9291

9392
## Pull Requests
9493

95-
[Pull requests](https://github.com/alexrp/system-terminal/pulls) are a great way
96-
to contribute, whether it be code or documentation improvements. It is a good
97-
idea to check the issue tracker to see if someone else is already working on
94+
[Pull requests](https://github.com/alexrp/cathode/pulls) are a great way to
95+
contribute, whether it be code or documentation improvements. It is a good idea
96+
to check the issue tracker to see if someone else is already working on
9897
something before you start work on it. For feature additions, it is also
9998
important to open a feature request on the issue tracker to see if the
10099
maintainers are actually interested in merging it.
@@ -141,10 +140,10 @@ Once you have a forked repository, clone and set it up locally:
141140

142141
```bash
143142
# Replace <your-name> with your GitHub user name.
144-
git clone git@github.com:<your-name>/system-terminal.git
145-
cd system-terminal
143+
git clone git@github.com:<your-name>/cathode.git
144+
cd cathode
146145
# Set up a remote pointing to the upstream repository.
147-
git remote add upstream git@github.com:alexrp/system-terminal.git
146+
git remote add upstream git@github.com:alexrp/cathode.git
148147
```
149148

150149
Whenever you need to update your fork, do something like this:

‎Directory.Build.props‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<Project>
22
<PropertyGroup>
3-
<Product>System.Terminal</Product>
4-
<Description>System.Terminal is a terminal-centric replacement for System.Console.</Description>
3+
<Product>Cathode</Product>
4+
<Description>Cathode is a terminal-centric replacement for System.Console.</Description>
55
<Authors>The $(Product) Maintainers</Authors>
66
<Copyright>Copyright © $(Authors)</Copyright>
77
</PropertyGroup>
@@ -26,15 +26,15 @@
2626

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
29-
Windows console host and the many limitations it had. System.Terminal provides
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+
29+
Windows console host and the many limitations it had. Cathode provides an API
30+
centered around a VT100 terminal with some extensions from later models and
31+
modern terminal emulators. It works on all desktop platforms that .NET 6+
3232
supports.</PackageDescription>
3333
<PackageLicenseExpression>0BSD</PackageLicenseExpression>
3434
<PackageOutputPath>$(MSBuildThisFileDirectory)pkg/feed/</PackageOutputPath>
35-
<PackageProjectUrl>https://github.com/alexrp/system-terminal</PackageProjectUrl>
35+
<PackageProjectUrl>https://github.com/alexrp/cathode</PackageProjectUrl>
3636
<PublishRepositoryUrl>true</PublishRepositoryUrl>
37-
<RepositoryUrl>https://github.com/alexrp/system-terminal.git</RepositoryUrl>
37+
<RepositoryUrl>https://github.com/alexrp/cathode.git</RepositoryUrl>
3838
<TargetFramework>net6.0</TargetFramework>
3939
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
4040
</PropertyGroup>

‎Directory.Build.targets‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@
2424
<PropertyGroup>
2525
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
2626
<IsTrimmable Condition="'$(OutputType)' == 'Library' and '$(DevelopmentDependency)' != 'true'">>true</IsTrimmable>
27-
<PackageIcon>system-terminal.png</PackageIcon>
27+
<PackageIcon>cathode.png</PackageIcon>
2828
<PackageReadmeFile>PACKAGE.md</PackageReadmeFile>
2929
</PropertyGroup>
3030

3131
<ItemGroup>
32-
<None Include="$(MSBuildThisFileDirectory)PACKAGE.md; $(MSBuildThisFileDirectory)system-terminal.png"
32+
<None Include="$(MSBuildThisFileDirectory)PACKAGE.md; $(MSBuildThisFileDirectory)cathode.png"
3333
Pack="true"
3434
PackagePath=""
3535
Visible="false" />
@@ -53,7 +53,7 @@
5353
BeforeTargets="GenerateNuspec"
5454
Condition="'$(IsPackable)' == 'true'">
5555
<PropertyGroup>
56-
<PackageReleaseNotes>https://github.com/alexrp/system-terminal/releases/tag/v$(Version)</PackageReleaseNotes>
56+
<PackageReleaseNotes>https://github.com/alexrp/cathode/releases/tag/v$(Version)</PackageReleaseNotes>
5757
</PropertyGroup>
5858
</Target>
5959

‎PACKAGE.md‎

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,29 @@
1-
# System.Terminal
1+
# Cathode
22

3-
System.Terminal is a toolkit for writing terminal-based applications. It is
4-
effectively a complete replacement for System.Console.
3+
Cathode is a toolkit for writing terminal-based applications. It is effectively
4+
a complete replacement for System.Console.
55

66
With the Windows console host now supporting virtual terminal sequences, it
77
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.
8+
Windows console host and the many limitations it had. Cathode provides an API
9+
centered around a [VT100 terminal](https://vt100.net) with some extensions from
10+
later models and modern terminal emulators. It works on all desktop platforms
11+
that .NET 6+ supports.
1212

1313
This project offers the following packages:
1414

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
15+
* [Cathode](https://www.nuget.org/packages/Cathode): Provides the core terminal
16+
API.
17+
* [Cathode.Analyzers](https://www.nuget.org/packages/Cathode.Analyzers):
18+
Provides diagnostic analyzers and source generators.
19+
* [Cathode.Hosting](https://www.nuget.org/packages/Cathode.Hosting): Provides
1820
the terminal hosting model.
19-
* [Terminal.Extensions](https://www.nuget.org/packages/Terminal.Extensions):
21+
* [Cathode.Extensions](https://www.nuget.org/packages/Cathode.Extensions):
2022
Provides terminal hosting and logging for the .NET Generic Host.
2123

2224
See the
23-
[sample programs](https://github.com/alexrp/system-terminal/tree/master/src/samples)
25+
[sample programs](https://github.com/alexrp/cathode/tree/master/src/samples)
2426
for examples of what the API can do.
2527

2628
For more information, please visit the
27-
[project page](https://github.com/alexrp/system-terminal).
29+
[project page](https://github.com/alexrp/cathode).

‎README.md‎

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# System.Terminal
1+
# Cathode
22

33
<div align="center">
4-
<img src="system-terminal.svg"
4+
<img src="cathode.svg"
55
width="128" />
66
</div>
77

@@ -13,57 +13,57 @@
1313

1414
<div align="center">
1515

16-
[![License](https://img.shields.io/github/license/alexrp/system-terminal?color=brown)](LICENSE.md)
17-
[![Commits](https://img.shields.io/github/commit-activity/m/alexrp/system-terminal/master?label=commits&color=slateblue)](https://github.com/alexrp/system-terminal/commits/master)
18-
[![Build](https://img.shields.io/github/workflow/status/alexrp/system-terminal/Build/master)](https://github.com/alexrp/system-terminal/actions/workflows/build.yml)
16+
[![License](https://img.shields.io/github/license/alexrp/cathode?color=brown)](LICENSE.md)
17+
[![Commits](https://img.shields.io/github/commit-activity/m/alexrp/cathode/master?label=commits&color=slateblue)](https://github.com/alexrp/cathode/commits/master)
18+
[![Build](https://img.shields.io/github/workflow/status/alexrp/cathode/Build/master)](https://github.com/alexrp/cathode/actions/workflows/build.yml)
1919
[![Sponsors](https://img.shields.io/github/sponsors/alexrp?color=mediumorchid)](https://github.com/sponsors/alexrp)
20-
[![Discussions](https://img.shields.io/github/discussions/alexrp/system-terminal?color=teal)](https://github.com/alexrp/system-terminal/discussions)
20+
[![Discussions](https://img.shields.io/github/discussions/alexrp/cathode?color=teal)](https://github.com/alexrp/cathode/discussions)
2121

2222
</div>
2323

2424
---
2525

26-
System.Terminal is a toolkit for writing terminal-based applications. It is
27-
effectively a complete replacement for System.Console.
26+
Cathode is a toolkit for writing terminal-based applications. It is effectivel
27+
a complete replacement for System.Console.
2828

2929
With the Windows console host now supporting virtual terminal sequences, it
3030
makes little sense for console interaction to still be centered around the old
31-
Windows console host and the many limitations it had. System.Terminal provides
32-
an API centered around a [VT100 terminal](https://vt100.net) with some
33-
extensions from later models and modern terminal emulators. It works on all
34-
desktop platforms that .NET 6+ supports.
31+
Windows console host and the many limitations it had. Cathode provides an API
32+
centered around a [VT100 terminal](https://vt100.net) with some extensions from
33+
later models and modern terminal emulators. It works on all desktop platforms
34+
that .NET 6+ supports.
3535

36-
Please note that, since System.Terminal replaces a very fundamental component of
37-
the framework, the use of certain framework APIs becomes problematic. As an
38-
example, intermixing System.Terminal and System.Console usage *will* break.
39-
Referencing System.Terminal (or a package that uses it) will pull in a Roslyn
40-
analyzer which will diagnose problematic APIs and suggest working replacements.
36+
Please note that, since Cathode replaces a very fundamental component of the
37+
framework, the use of certain framework APIs becomes problematic. As an example,
38+
intermixing Cathode and System.Console usage *will* break. Referencing Cathode
39+
(or a package that uses it) will pull in a Roslyn analyzer which will diagnose
40+
problematic APIs and suggest working replacements.
4141

4242
## Usage
4343

4444
This project offers the following packages:
4545

4646
| Package | Description | Downloads |
4747
| -: | - | :- |
48-
| [![Terminal][core-img]][core-pkg] | Provides the core terminal API. | ![Downloads][core-dls] |
49-
| [![Terminal.Analyzers][analyzers-img]][analyzers-pkg] | Provides diagnostic analyzers and source generators. | ![Downloads][analyzers-dls] |
50-
| [![Terminal.Hosting][hosting-img]][hosting-pkg] | Provides the terminal hosting model. | ![Downloads][hosting-dls] |
51-
| [![Terminal.Extensions][extensions-img]][extensions-pkg] | Provides terminal hosting and logging for the .NET Generic Host. | ![Downloads][extensions-dls] |
52-
53-
[core-pkg]: https://www.nuget.org/packages/Terminal
54-
[analyzers-pkg]: https://www.nuget.org/packages/Terminal.Analyzers
55-
[hosting-pkg]: https://www.nuget.org/packages/Terminal.Hosting
56-
[extensions-pkg]: https://www.nuget.org/packages/Terminal.Extensions
57-
58-
[core-img]: https://img.shields.io/nuget/v/Terminal?label=Terminal
59-
[analyzers-img]: https://img.shields.io/nuget/v/Terminal.Analyzers?label=Terminal.Analyzers
60-
[hosting-img]: https://img.shields.io/nuget/v/Terminal.Hosting?label=Terminal.Hosting
61-
[extensions-img]: https://img.shields.io/nuget/v/Terminal.Extensions?label=Terminal.Extensions
62-
63-
[core-dls]: https://img.shields.io/nuget/dt/Terminal?label=
64-
[analyzers-dls]: https://img.shields.io/nuget/dt/Terminal.Analyzers?label=
65-
[hosting-dls]: https://img.shields.io/nuget/dt/Terminal.Hosting?label=
66-
[extensions-dls]: https://img.shields.io/nuget/dt/Terminal.Extensions?label=
48+
| [![Cathode][core-img]][core-pkg] | Provides the core terminal API. | ![Downloads][core-dls] |
49+
| [![Cathode.Analyzers][analyzers-img]][analyzers-pkg] | Provides diagnostic analyzers and source generators. | ![Downloads][analyzers-dls] |
50+
| [![Cathode.Hosting][hosting-img]][hosting-pkg] | Provides the terminal hosting model. | ![Downloads][hosting-dls] |
51+
| [![Cathode.Extensions][extensions-img]][extensions-pkg] | Provides terminal hosting and logging for the .NET Generic Host. | ![Downloads][extensions-dls] |
52+
53+
[core-pkg]: https://www.nuget.org/packages/Cathode
54+
[analyzers-pkg]: https://www.nuget.org/packages/Cathode.Analyzers
55+
[hosting-pkg]: https://www.nuget.org/packages/Cathode.Hosting
56+
[extensions-pkg]: https://www.nuget.org/packages/Cathode.Extensions
57+
58+
[core-img]: https://img.shields.io/nuget/v/Cathode?label=Cathode
59+
[analyzers-img]: https://img.shields.io/nuget/v/Cathode.Analyzers?label=Cathode.Analyzers
60+
[hosting-img]: https://img.shields.io/nuget/v/Cathode.Hosting?label=Cathode.Hosting
61+
[extensions-img]: https://img.shields.io/nuget/v/Cathode.Extensions?label=Cathode.Extensions
62+
63+
[core-dls]: https://img.shields.io/nuget/dt/Cathode?label=
64+
[analyzers-dls]: https://img.shields.io/nuget/dt/Cathode.Analyzers?label=
65+
[hosting-dls]: https://img.shields.io/nuget/dt/Cathode.Hosting?label=
66+
[extensions-dls]: https://img.shields.io/nuget/dt/Cathode.Extensions?label=
6767

6868
To install a package, run `dotnet add package <name>`.
6969

@@ -96,7 +96,7 @@ emulators:
9696

9797
(Even if you are using a terminal emulator that is not listed here, chances are
9898
that it will work just fine; these are just the ones that are tested regularly
99-
while developing System.Terminal.)
99+
while developing Cathode.)
100100

101101
## Statistics
102102

‎RELEASE.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Before tagging a release, build the release branch locally on all platforms that
1313
you have access to and run the [sample programs](src/samples) with all terminal
1414
emulators you have access to. Verify that nothing has regressed. Also, ensure
1515
that the release branch builds and tests successfully on
16-
[CI](https://github.com/alexrp/system-terminal/actions).
16+
[CI](https://github.com/alexrp/cathode/actions).
1717

1818
Next, run `dotnet nbgv tag` from the release branch to create a release tag, and
1919
push it with `git push origin <tag>`. Again, wait for CI to build and test the
@@ -22,7 +22,7 @@ tag. If something goes wrong on CI, you can run `git tag -d <tag>` and
2222
then repeat this step.
2323

2424
Finally, to actually publish the release, go to the
25-
[releases page](https://github.com/alexrp/system-terminal/releases) to create a
26-
release from the tag you pushed, ideally with some well-written release notes.
27-
Once the release is published, a workflow will build and publish NuGet packages
28-
from the tag.
25+
[releases page](https://github.com/alexrp/cathode/releases) to create a release
26+
from the tag you pushed, ideally with some well-written release notes. Once the
27+
release is published, a workflow will build and publish NuGet packages from the
28+
tag.

‎SUPPORT.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
# Support
22

33
The project has a [GitHub Discussions](https://docs.github.com/en/discussions) forum:
4-
[![GitHub Discussions](https://img.shields.io/github/discussions/alexrp/system-terminal)](https://github.com/alexrp/system-terminal/discussions)
4+
[![GitHub Discussions](https://img.shields.io/github/discussions/alexrp/cathode)](https://github.com/alexrp/cathode/discussions)
55

66
Please do *not* use the
7-
[issue tracker](https://github.com/alexrp/system-terminal/issues) for support
8-
requests.
7+
[issue tracker](https://github.com/alexrp/cathode/issues) for support requests.
98

109
When seeking help, please note the following:
1110

‎cathode.png‎

13.1 KB
Loading

system-terminal.proj renamed to cathode.proj

File renamed without changes.

0 commit comments

Comments
 (0)