diff --git a/NoSamples.slnf b/NoSamples.slnf index 60dfeeede..92ea26213 100644 --- a/NoSamples.slnf +++ b/NoSamples.slnf @@ -3,7 +3,7 @@ "path": "Terminal.sln", "projects": [ "Terminal.Gui\\Terminal.Gui.csproj", - "UICatalog\\UICatalog.csproj", + "Examples\\UICatalog\\UICatalog.csproj", "Tests\\UnitTests\\UnitTests.csproj", "Tests\\UnitTestsParallelizable\\UnitTests.Parallelizable.csproj", "Tests\\IntegrationTests\\IntegrationTests.csproj", diff --git a/README.md b/README.md index d3339303b..0e81f8ae1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ -![Terminal.Gui](https://socialify.git.ci/gui-cs/Terminal.Gui/image?description=1&descriptionEditable=Cross%20Platform%20Terminal%20UI%20Toolkit&font=KoHo&forks=1&logo=https%3A%2F%2Fgithub.com%2Fgui-cs%2FTerminal.Gui%2Fblob%2Fv2_develop%2Fdocfx%2Fimages%2Flogo.png%3Fraw%3Dtrue&pattern=Circuit%20Board&stargazers=1&theme=Dark) ![.NET Core](https://github.com/gui-cs/Terminal.Gui/workflows/.NET%20Core/badge.svg?branch=develop) [![Version](https://img.shields.io/nuget/v/Terminal.Gui.svg)](https://www.nuget.org/packages/Terminal.Gui) ![Code Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/migueldeicaza/90ef67a684cb71db1817921a970f8d27/raw/code-coverage.json) @@ -6,16 +5,25 @@ [![License](https://img.shields.io/github/license/gui-cs/gui.cs.svg)](LICENSE) ![Bugs](https://img.shields.io/github/issues/gui-cs/gui.cs/bug) +# Terminal.Gui + +The premier toolkit for building rich console apps for Windows, the Mac, and Linux/Unix. + +![logo](docfx/images/logo.png) + * The current, stable, release of Terminal.Gui v1 is [![Version](https://img.shields.io/nuget/v/Terminal.Gui.svg)](https://www.nuget.org/packages/Terminal.Gui). -* The current `prealpha` release of Terminal.Gui v2 can be found on [Nuget](https://www.nuget.org/packages/Terminal.Gui). -* 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. -* `v1` is in maintenance mode and we will only accept PRs for issues impacting existing functionality. - -**Terminal.Gui**: A toolkit for building rich console apps for Windows, the Mac, and Linux/Unix. + +> :warning: **Note:** +> `v1` is in maintenance mode and we will only accept PRs for issues impacting existing functionality. + +* The current `prealpha` release of Terminal.Gui v2 is ![NuGet Version](https://img.shields.io/nuget/vpre/Terminal.Gui) + +> :warning: **Note:** +> 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. ![Sample app](docfx/images/sample.gif) -## Quick Start +# 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. @@ -36,43 +44,39 @@ dotnet run --project Examples/UICatalog/UICatalog.csproj There is also a [visual designer](https://github.com/gui-cs/TerminalGuiDesigner) (uses Terminal.Gui itself). -## Documentation +# Documentation -* [Getting Started](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/getting-started.html) -* [What's new in v2](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/newinv2.html) -* [API Documentation](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.html) -* [Documentation Home](https://gui-cs.github.io/Terminal.GuiV2Docs) +The full developer documentation for Terminal.Gui is available at [gui-cs.github.io/Terminal.GuiV2Docs](https://gui-cs.github.io/Terminal.GuiV2Docs/). -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). +## Getting Started -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. +- [Getting Started](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/getting-started.md) - Quick start guide to create your first Terminal.Gui application +- [Migrating from v1 to v2](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/migratingfromv1.md) - Complete guide for upgrading existing applications +- [What's New in v2](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/newinv2.md) - Overview of new features and improvements -## Showcase & Examples +## API Reference -* 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. +For detailed API documentation, see the [API Reference](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.App.html). -* [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! +# Installing -## Sample Usage in C# +Use NuGet to install the `Terminal.Gui` NuGet package: -The following example shows a basic Terminal.Gui application in C#: -[Example (source)](./Examples/Example/Example.cs) +## v2 Pre-Alpha -When run the application looks as follows: +(Infrequently updated, but stable enough for production use) +``` +dotnet add package Terminal.Gui --version "2.0.0-prealpha.*" +``` -![Simple Usage app](./docfx/images/Example.png) +## v2 Develop -## Sample usage in F# +(Frequently updated, but may have breaking changes) +``` +dotnet add package Terminal.Gui --version "2.0.0-develop.*" +``` -An F# example is located [here](./Examples/FSharpExample/Program.fs). - -## Installing - -Use NuGet to install the `Terminal.Gui` NuGet package: https://www.nuget.org/packages/Terminal.Gui - -### Installation in .NET Core Projects - -To install Terminal.Gui into a .NET Core project, use the `dotnet` CLI tool with this command. +## Legacy v1 ``` dotnet add package Terminal.Gui @@ -80,12 +84,12 @@ dotnet add package Terminal.Gui Or, you can use the [Terminal.Gui.Templates](https://github.com/gui-cs/Terminal.Gui.templates). -## Contributing +# Contributing See [CONTRIBUTING.md](./CONTRIBUTING.md). 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). -## History +# History See [gui-cs](https://github.com/gui-cs/) for how this project came to be. diff --git a/Release.slnf b/Release.slnf index c87196ae5..d2740a79c 100644 --- a/Release.slnf +++ b/Release.slnf @@ -3,7 +3,7 @@ "path": "Terminal.sln", "projects": [ "Terminal.Gui\\Terminal.Gui.csproj", - "UICatalog\\UICatalog.csproj", + "Examples\\UICatalog\\UICatalog.csproj", "Tests\\UnitTests\\UnitTests.csproj", "Tests\\UnitTestsParallelizable\\UnitTests.Parallelizable.csproj", "Tests\\IntegrationTests\\IntegrationTests.csproj", diff --git a/local_packages/Terminal.Gui.2.0.0.nupkg b/local_packages/Terminal.Gui.2.0.0.nupkg index 34e4cc37c..ad40cd278 100644 Binary files a/local_packages/Terminal.Gui.2.0.0.nupkg and b/local_packages/Terminal.Gui.2.0.0.nupkg differ diff --git a/local_packages/Terminal.Gui.2.0.0.snupkg b/local_packages/Terminal.Gui.2.0.0.snupkg index ee19faced..817855ade 100644 Binary files a/local_packages/Terminal.Gui.2.0.0.snupkg and b/local_packages/Terminal.Gui.2.0.0.snupkg differ diff --git a/nuget.config b/nuget.config index c5478a199..5ac744e94 100644 --- a/nuget.config +++ b/nuget.config @@ -8,8 +8,8 @@ - +