mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-26 15:57:56 +01:00
updated relnotes, regenerated ddocs, inheritdoc tool now runs only on RELEASE builds
This commit is contained in:
11
README.md
11
README.md
@@ -10,6 +10,10 @@ A simple toolkit for buiding console GUI apps for .NET, .NET Core, and Mono that
|
||||
|
||||

|
||||
|
||||
## IMPORTANT RELEASE INFO
|
||||
|
||||
We are actively converging on a major update to Terminal.Gui. The most recent released Nuget package is version `0.81` which is way behind `master`. This README and the API Documentation refers to the latest build from `master`. If you want the latest and greatest functionality, clone and build locally. Otherwise `0.81` is quite stable, but the documentation may not match.
|
||||
|
||||
## Controls & Features
|
||||
|
||||
The *Terminal.Gui* toolkit contains various controls for building text user interfaces:
|
||||
@@ -176,13 +180,14 @@ The example above shows how to add views using both styles of layout supported b
|
||||
|
||||
## Installing
|
||||
|
||||
*We are actively converging on a major update to Terminal.Gui. The most recent released Nuget package is version `0.81` which is way behind `master`. This README and the API Documentation refers to the latest build from `master`. If you want the latest and greatest functionality, clone and build locally. Otherwise `0.81` is quite stable, but the documentation may not match.*
|
||||
|
||||
Use NuGet to install the `Terminal.Gui` NuGet package: https://www.nuget.org/packages/Terminal.Gui
|
||||
|
||||
## Running and Building
|
||||
|
||||
* Windows - Build and run using the .NET SDK command line tools (`dotnet build` in the root directory) or open `Terminal.Gui.sln` with Visual Studio 2019.
|
||||
* Mac - ???
|
||||
* Linux - (see: https://github.com/migueldeicaza/gui.cs/issues/421)
|
||||
* Windows, Mac, and Linux - Build and run using the .NET SDK command line tools (`dotnet build` in the root directory)
|
||||
* Windows - Open `Terminal.Gui.sln` with Visual Studio 2019.
|
||||
|
||||
## Contributing
|
||||
|
||||
|
||||
Reference in New Issue
Block a user