Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2025-12-26 15:57:56 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added templates to readme

Browse Source
This commit is contained in:
Charlie Kindel
2022-10-17 14:06:38 -06:00
parent 066e23cafb
commit 43c47b5c22
1 changed files with 18 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -12,6 +12,20 @@ A toolkit for building rich console apps for .NET, .NET Core, and Mono that work
![Sample app](docfx/images/sample.gif)
## Quick Start
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.
(Press `CTRL-Q` to exit the app)
```powershell
dotnet new --install Terminal.Gui.templates
dotnet new tui -n myproj
cd myproj
dotnet run
```
## Documentation
* [Documentation Home](https://gui-cs.github.io/Terminal.Gui/index.html)
@@ -153,13 +167,15 @@ To install Terminal.Gui into a .NET Core project, use the `dotnet` CLI tool with
dotnet add package Terminal.Gui
```
See [CONTRIBUTING.md](CONTRIBUTING.md) for instructions for downloading and forking the source.
Or, you can use the [Terminal.Gui.Templates](https://github.com/gui-cs/Terminal.Gui.templates).
## Running and Building
## Building the Library and Running the Examples
* Windows, Mac, and Linux - Build and run using the .NET SDK command line tools (`dotnet build` in the root directory). Run `UICatalog` with `dotnet run --project UICatalog`.
* Windows - Open `Terminal.sln` with Visual Studio 2022.
See [CONTRIBUTING.md](CONTRIBUTING.md) for instructions for downloading and forking the source.
## Contributing
See [CONTRIBUTING.md](https://github.com/gui-cs/Terminal.Gui/blob/master/CONTRIBUTING.md).