Skip to content

Commit ba4503a

Browse files
committed
Fixed release builds 4
1 parent 96004e1 commit ba4503a

File tree

6 files changed

+41
-37
lines changed

6 files changed

+41
-37
lines changed

NoSamples.slnf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"path": "Terminal.sln",
44
"projects": [
55
"Terminal.Gui\\Terminal.Gui.csproj",
6-
"UICatalog\\UICatalog.csproj",
6+
"Examples\\UICatalog\\UICatalog.csproj",
77
"Tests\\UnitTests\\UnitTests.csproj",
88
"Tests\\UnitTestsParallelizable\\UnitTests.Parallelizable.csproj",
99
"Tests\\IntegrationTests\\IntegrationTests.csproj",

README.md

Lines changed: 38 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,29 @@
1-
![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)
21
![.NET Core](https://github.com/gui-cs/Terminal.Gui/workflows/.NET%20Core/badge.svg?branch=develop)
32
[![Version](https://img.shields.io/nuget/v/Terminal.Gui.svg)](https://www.nuget.org/packages/Terminal.Gui)
43
![Code Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/migueldeicaza/90ef67a684cb71db1817921a970f8d27/raw/code-coverage.json)
54
[![Downloads](https://img.shields.io/nuget/dt/Terminal.Gui)](https://www.nuget.org/packages/Terminal.Gui)
65
[![License](https://img.shields.io/github/license/gui-cs/gui.cs.svg)](LICENSE)
76
![Bugs](https://img.shields.io/github/issues/gui-cs/gui.cs/bug)
87

8+
# Terminal.Gui
9+
10+
The premier toolkit for building rich console apps for Windows, the Mac, and Linux/Unix.
11+
12+
![logo](docfx/images/logo.png)
13+
914
* 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).
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 ![NuGet Version](https://img.shields.io/nuget/vpre/Terminal.Gui)
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.
1523
1624
![Sample app](docfx/images/sample.gif)
1725

18-
## Quick Start
26+
# Quick Start
1927

2028
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.
2129

@@ -36,56 +44,52 @@ dotnet run --project Examples/UICatalog/UICatalog.csproj
3644

3745
There is also a [visual designer](https://github.com/gui-cs/TerminalGuiDesigner) (uses Terminal.Gui itself).
3846

39-
## Documentation
40-
41-
* [Getting Started](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/getting-started.html)
42-
* [What's new in v2](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/newinv2.html)
43-
* [API Documentation](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.html)
44-
* [Documentation Home](https://gui-cs.github.io/Terminal.GuiV2Docs)
47+
# Documentation
4548

46-
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/).
4750

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
4952

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
5156

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
5358

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).
5560

56-
## Sample Usage in C#
61+
# Installing
5762

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:
6064

61-
When run the application looks as follows:
65+
## v2 Pre-Alpha
6266

63-
![Simple Usage app](./docfx/images/Example.png)
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)
68+
```
69+
dotnet add package Terminal.Gui --version "2.0.0-prealpha.*"
70+
```
7071

71-
Use NuGet to install the `Terminal.Gui` NuGet package: https://www.nuget.org/packages/Terminal.Gui
72+
## v2 Develop
7273

73-
### Installation in .NET Core Projects
74+
(Frequently updated, but may have breaking changes)
75+
```
76+
dotnet add package Terminal.Gui --version "2.0.0-develop.*"
77+
```
7478

75-
To install Terminal.Gui into a .NET Core project, use the `dotnet` CLI tool with this command.
79+
## Legacy v1
7680

7781
```
7882
dotnet add package Terminal.Gui
7983
```
8084

8185
Or, you can use the [Terminal.Gui.Templates](https://github.com/gui-cs/Terminal.Gui.templates).
8286

83-
## Contributing
87+
# Contributing
8488

8589
See [CONTRIBUTING.md](./CONTRIBUTING.md).
8690

8791
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).
8892

89-
## History
93+
# History
9094

9195
See [gui-cs](https://github.com/gui-cs/) for how this project came to be.

Release.slnf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"path": "Terminal.sln",
44
"projects": [
55
"Terminal.Gui\\Terminal.Gui.csproj",
6-
"UICatalog\\UICatalog.csproj",
6+
"Examples\\UICatalog\\UICatalog.csproj",
77
"Tests\\UnitTests\\UnitTests.csproj",
88
"Tests\\UnitTestsParallelizable\\UnitTests.Parallelizable.csproj",
99
"Tests\\IntegrationTests\\IntegrationTests.csproj",
-378 Bytes
Binary file not shown.
-6 Bytes
Binary file not shown.

nuget.config

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88

99
<!--To inherit the global NuGet package sources remove the <clear/> line below -->
1010
<clear />
11-
<add key="nuget" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
1211
<add key="LocalPackages" value="./local_packages" />
12+
<add key="nuget" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
1313
</packageSources>
1414
<packageSourceMapping>
1515
<packageSource key="nuget">

0 commit comments

Comments
 (0)