Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2026-01-01 08:50:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated readmes

Browse Source
This commit is contained in:
Tigger Kindel
2023-04-06 09:25:47 -06:00
committed by Tig
parent 8cbe7cbf90
commit ad5e25966b
2 changed files with 16 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -7,15 +7,12 @@
[![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)
***The current release of Terminal.Gui [(v1.10)](https://www.nuget.org/packages/Terminal.Gui) is stable, rich, and broadly used. The team is now focused on designing and building a significant upgrade we're referring to as `v2`. Therefore, `v1` is now in maintenance mode.***
***The current, stable, release of Terminal.Gui is [v1.x](https://www.nuget.org/packages/Terminal.Gui). It is stable, rich, and broadly used. The team is now focused on designing and building a significant upgrade we're referring to as `v2`. Therefore:***
* *`v1` is now in maintenance mode, meaning we will accept PRs for v1.x (the `develop` branch) only for issues impacting existing functionality.*
* *All new development happens on the `v2_develop` branch. See the V2 discussion [here](https://github.com/gui-cs/Terminal.Gui/discussions/1940).*
* *Developers are encouraged to continue building on [v1.x](https://www.nuget.org/packages/Terminal.Gui) until we announce `v2` is stable.*
***This means we will accept PRs for v1.x (the `develop` branch) only for issues impacting existing functionality. All new development will happen on the `v2_develop` branch. See the V2 discussion [here](https://github.com/gui-cs/Terminal.Gui/discussions/1940).***
***Developers are encouraged to continue building on `v1` until we announce `v2` is stable.***
# Terminal.Gui - Cross Platform Terminal UI toolkit for .NET
A toolkit for building rich console apps for .NET, .NET Core, and Mono that works on Windows, the Mac, and Linux/Unix.
**Terminal.Gui**: A toolkit for building rich console apps for .NET, .NET Core, and Mono that works on Windows, the Mac, and Linux/Unix.
![Sample app](docfx/images/sample.gif)

17
Terminal.Gui/README.md
View File

@@ -49,6 +49,16 @@ Doing so will update the `.csproj` files in your branch with version info, which
## Publishing a Release of Terminal.Gui
First, use the [Semantic Versioning](https://semver.org/) rules.to determine the new verison number.
Given a version number MAJOR.MINOR.PATCH, increment the:
* MAJOR version when you make incompatible API changes
* MINOR version when you add functionality in a backwards compatible manner
* PATCH version when you make backwards compatible bug fixes
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
To release a new version (e.g. with a higher `major`, `minor`, or `patch` value) tag a commit using `git tag` and then push that tag directly to the `main` branch on `github.com/gui-cs/Terminal.Gui` (`upstream`).
The `tag` must be of the form `v<major>.<minor>.<patch>`, e.g. `v2.3.4`.
@@ -117,13 +127,8 @@ https://www.nuget.org/packages/Terminal.Gui
### 10) Add a new Release in Github: https://github.com/gui-cs/Terminal.Gui/releases
Generate release notes with the list of PRs since the last release
Generate release notes with the list of PRs since the last release.
Use `gh` to get a list with just titles to make it easy to paste into release notes:
```powershell
gh pr list --limit 500 --search "is:pr is:closed is:merged closed:>=2021-05-18"
```
### 11) Update the `develop` branch with the new version
```powershell