You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The premier toolkit for building rich console apps for Windows, the Mac, and Linux/Unix.
11
+
12
+

13
+
9
14
* The current, stable, release of Terminal.Gui v1 is [](https://www.nuget.org/packages/Terminal.Gui).
10
-
* The current `prealpha` release of Terminal.Gui v2 can be found on [Nuget](https://www.nuget.org/packages/Terminal.Gui).
11
-
* Developers starting new TUI projects are encouraged to target `v2`. The API is significantly changed, and significantly improved. There will be breaking changes in the API before Beta, but the core API is stable.
12
-
*`v1` is in maintenance mode and we will only accept PRs for issues impacting existing functionality.
13
-
14
-
**Terminal.Gui**: A toolkit for building rich console apps for Windows, the Mac, and Linux/Unix.
15
+
16
+
> :warning:**Note:**
17
+
> `v1` is in maintenance mode and we will only accept PRs for issues impacting existing functionality.
18
+
19
+
* The current `prealpha` release of Terminal.Gui v2 is 
20
+
21
+
> :warning:**Note:**
22
+
> Developers starting new TUI projects are encouraged to target `v2`. The API is significantly changed, and significantly improved. There will be breaking changes in the API before Beta, but the core API is stable.
15
23
16
24

17
25
18
-
##Quick Start
26
+
# Quick Start
19
27
20
28
Paste these commands into your favorite terminal on Windows, Mac, or Linux. This will install the [Terminal.Gui.Templates](https://github.com/gui-cs/Terminal.Gui.templates), create a new "Hello World" TUI app, and run it.
21
29
@@ -36,56 +44,52 @@ dotnet run --project Examples/UICatalog/UICatalog.csproj
36
44
37
45
There is also a [visual designer](https://github.com/gui-cs/TerminalGuiDesigner) (uses Terminal.Gui itself).
The above documentation matches the most recent Nuget release from the `v2_develop` branch. Get the [v1 documentation here](https://gui-cs.github.io/Terminal.Gui/api/Terminal.Gui.html).
49
+
The full developer documentation for Terminal.Gui is available at [gui-cs.github.io/Terminal.GuiV2Docs](https://gui-cs.github.io/Terminal.GuiV2Docs/).
47
50
48
-
See the [`Terminal.Gui/`README](https://github.com/gui-cs/Terminal.Gui/tree/master/Terminal.Gui) for an overview of how the library is structured.
51
+
## Getting Started
49
52
50
-
## Showcase & Examples
53
+
-[Getting Started](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/getting-started.md) - Quick start guide to create your first Terminal.Gui application
54
+
-[Migrating from v1 to v2](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/migratingfromv1.md) - Complete guide for upgrading existing applications
55
+
-[What's New in v2](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/newinv2.md) - Overview of new features and improvements
51
56
52
-
* The [./Examples/UICatalog](./Examples/UICatalog) project is a showcase of all the controls and features of the toolkit. There are more examples in the [./Examples](./Examples) folder.
57
+
## API Reference
53
58
54
-
*[Showcase](https://github.com/gui-cs/Terminal.Gui/blob/develop/Showcase.md) is a place where you can find all kind of projects from simple examples to advanced real world apps that fully utilize capabilities of the toolkit. The team is looking forward to seeing new amazing projects made by the community to be added there!
59
+
For detailed API documentation, see the [API Reference](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.App.html).
55
60
56
-
## Sample Usage in C#
61
+
#Installing
57
62
58
-
The following example shows a basic Terminal.Gui application in C#:
59
-
[Example (source)](./Examples/Example/Example.cs)
63
+
Use NuGet to install the `Terminal.Gui` NuGet package:
60
64
61
-
When run the application looks as follows:
65
+
## v2 Pre-Alpha
62
66
63
-

64
-
65
-
## Sample usage in F#
66
-
67
-
An F# example is located [here](./Examples/FSharpExample/Program.fs).
68
-
69
-
## Installing
67
+
(Infrequently updated, but stable enough for production use)
To install Terminal.Gui into a .NET Core project, use the `dotnet` CLI tool with this command.
79
+
## Legacy v1
76
80
77
81
```
78
82
dotnet add package Terminal.Gui
79
83
```
80
84
81
85
Or, you can use the [Terminal.Gui.Templates](https://github.com/gui-cs/Terminal.Gui.templates).
82
86
83
-
##Contributing
87
+
# Contributing
84
88
85
89
See [CONTRIBUTING.md](./CONTRIBUTING.md).
86
90
87
91
Debates on architecture and design can be found in Issues tagged with [design](https://github.com/gui-cs/Terminal.Gui/issues?q=is%3Aopen+is%3Aissue+label%3Av2+label%3Adesign).
88
92
89
-
##History
93
+
# History
90
94
91
95
See [gui-cs](https://github.com/gui-cs/) for how this project came to be.
0 commit comments