Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Clarify v1 and v2 use cases
  • Loading branch information
tznind authored Sep 19, 2024
1 parent 7a48533 commit 4ad2faa
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,26 @@
[![NuGet Badge](https://buildstats.info/nuget/Terminal.gui.templates)](https://www.nuget.org/packages/Terminal.gui.templates/)

## Usage
# Usage
This is a template for creating Terminal.Gui applications using `dotnet new`.

To add this template to those available in `dotnet new` you will need to install the NuGet package:

# V1
Version 1 of [Terminal.Gui](https://github.com/gui-cs/Terminal.Gui) is stable and actively maintained but does not receive new features. To create projects using the V1 template install the latest version of the template:

```
dotnet new --install Terminal.Gui.templates
```

To use the v2 version of Terminal.Gui library you should instead reference the [latest version from nuget.org](https://www.nuget.org/packages/Terminal.gui.templates) e.g.
# V2
Version 2 of [Terminal.Gui](https://github.com/gui-cs/Terminal.Gui) is in alpha. To create projects using the v2 template you install the [latest version from nuget.org](https://www.nuget.org/packages/Terminal.gui.templates) e.g.

```
dotnet new install Terminal.Gui.Templates::2.0.0-v2-develop.2203
```

## Creating projects

After installing you can use the template to create new projects:

```
Expand Down

0 comments on commit 4ad2faa

Please sign in to comment.