diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 12e6859430..d837cfc822 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,14 +14,24 @@ Terminal.Gui uses the [GitFlow](https://nvie.com/posts/a-successful-git-branchin * The `develop` branch is where new development and bug-fixes happen. It is the default branch. ### Forking Terminal.Gui -* Use GitHub to fork the `Terminal.Gui` repo to your account (https://github.com/gui-cs/Terminal.Gui/fork). -* Clone your fork to your local machine (`git clone https://github.com//Terminal.Gui`) -* This will be your `origin` remote -* Add a remote for `upstream`: `git remote add upstream https://github.com/gui-cs/Terminal.Gui` -### Making Changes and Submitting Pull Requests +1. Use GitHub to fork the `Terminal.Gui` repo to your account (https://github.com/gui-cs/Terminal.Gui/fork). -#### When you start to make a change +2. Clone your fork to your local machine + +``` +git clone https://github.com//Terminal.Gui +``` + +Now, your local repo will have an `origin` remote pointing to `https://github.com//Terminal.Gui`. + +3. Add a remote for `upstream`: +``` +git remote add upstream https://github.com/gui-cs/Terminal.Gui +``` +You now have your own fork and a local repo that references it as `origin`. Your local repo also now references the orignal Terminal.Gui repo as `upstream`. + +### Starting to Make a Change Ensure your local `develop` branch is up-to-date with `upstream` (`github.com/gui-cs/Terminal.Gui`): ```powershell @@ -32,7 +42,7 @@ git pull upstream develop Create a new local branch: ```powershell -git checkout -b "my_new_branch" +git checkout -b my_new_branch ``` #### Making Changes @@ -53,13 +63,34 @@ git commit -m "Fixes #1234. Some bug" ### Submitting a Pull Request -Push your local branch to your fork (`origin`): +1. Push your local branch to your fork (`origin`): ```powershell -git push +git push --set-upstream origin my_new_branch ``` -## Coding Style +2. Create the Pull Request: + +In the output of the `git push` command you'll see instructions with a link to the Pull Request: + +```powershell + $ git push --set-upstream origin my_new_branch +Enumerating objects: 8, done. +... +remote: +remote: Create a pull request for 'my_new_branch' on GitHub by visiting: +remote: https://github.com//Terminal.Gui/pull/new/more_doc_fixes +remote: +... +``` + +3. Go to that URL and create the Pull Request: + +(in Windows Terminal, just CTRL-Click on the URL) + +Follow the template instructions found on Github. + +## Terminal.Gui Coding Style **Terminal.Gui** follows the [Mono Coding Guidelines](https://www.mono-project.com/community/contributing/coding-guidelines/). [`/.editorconfig`](https://github.com/gui-cs/Terminal.Gui/blob/b0a43ba338adf5ec069066e5a7dff8fea39b41db/.editorconfig) enforces this style in Visual Studio. Use `Ctrl-K-D` in Visual Studio to have it reformat code. @@ -87,13 +118,13 @@ git push ### Include API Documentation -Great care has been provided thus far in ensuring **Terminal.Gui** has great [API Documentation](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.html). Contributors have the responsibility of continuously improving the API Documentation. +Great care has been provided thus far in ensuring **Terminal.Gui** has great [API Documentation](https://gui-cs.github.io/Terminal.Gui/api/Terminal.Gui/Terminal.Gui.html). Contributors have the responsibility of continuously improving the API Documentation. - All public APIs must have clear, concise, and complete documentation in the form of [XML Documentation](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/). - Keep the `` terse. - Use `` liberally to cross-link topics. - Use `` to add more context and explanation. -- For complex topics, provide conceptual documentation in the `docfx/articles` folder as a `.md` file. It will automatically get picked up and be added to [Conceptual Documentation](https://migueldeicaza.github.io/gui.cs/articles/index.html). +- For complex topics, provide conceptual documentation in the `docfx/articles` folder as a `.md` file. It will automatically get picked up and be added to [Conceptual Documentation](https://gui-cs.github.io/Terminal.Gui/articles/index.html). - Use proper English and good grammar. ### Defining Events @@ -136,7 +167,7 @@ See also: https://www.codeproject.com/Articles/20550/C-Event-Implementation-Fund ## Breaking Changes to User Behavior or the Public API - Tag all pull requests that cause breaking changes to user behavior or the public API with the [breaking-change](https://github.com/gui-cs/Terminal.Gui/issues?q=is%3Aopen+is%3Aissue+label%3Abreaking-change) tag. This will help project maintainers track and document these. -- Add a `` to the XML Documentation to the code describing the breaking change. These will get picked up in the [API Documentation](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.html). +- Add a `` to the XML Documentation to the code describing the breaking change. These will get picked up in the [API Documentation](https://gui-cs.github.io/Terminal.Gui/api/Terminal.Gui/Terminal.Gui.html). ## Unit Tests diff --git a/Example/README.md b/Example/README.md index 48b532bf9b..6daac3cd7f 100644 --- a/Example/README.md +++ b/Example/README.md @@ -2,4 +2,4 @@ This is the original Terminal.Gui sample app. Over time we will be simplifying this sample to show just the basics of creating a Terminal.Gui app in C#. -See the Sample Code section [README.md](https://github.com/migueldeicaza/gui.cs) for a list of all samples. \ No newline at end of file +See the Sample Code section [README.md](https://github.com/gui-cs/Terminal.Gui) for a list of all samples. \ No newline at end of file diff --git a/README.md b/README.md index 81cbaa5563..cb4aaa1f42 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ -![.NET Core](https://github.com/migueldeicaza/gui.cs/workflows/.NET%20Core/badge.svg?branch=master) -![Code scanning - action](https://github.com/migueldeicaza/gui.cs/workflows/Code%20scanning%20-%20action/badge.svg) +![.NET Core](https://github.com/gui-cs/Terminal.Gui/workflows/.NET%20Core/badge.svg?branch=master) +![Code scanning - action](https://github.com/gui-cs/Terminal.Gui/workflows/Code%20scanning%20-%20action/badge.svg) [![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) [![Downloads](https://img.shields.io/nuget/dt/Terminal.Gui)](https://www.nuget.org/packages/Terminal.Gui) -[![License](https://img.shields.io/github/license/migueldeicaza/gui.cs.svg)](LICENSE) -![Bugs](https://img.shields.io/github/issues/migueldeicaza/gui.cs/bug) +[![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 - 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. -![Sample app](https://raw.githubusercontent.com/migueldeicaza/gui.cs/master/docfx/images/sample.gif) +![Sample app](https://raw.githubusercontent.com/gui-cs/Terminal.Gui/docfx/sample.gif) ## Controls and Views @@ -48,14 +48,14 @@ A toolkit for building rich console apps for .NET, .NET Core, and Mono that work ### Features -* **Cross Platform** - Windows, Mac, and Linux. Terminal drivers for Curses, [Windows Console](https://github.com/migueldeicaza/gui.cs/issues/27), and the .NET Console mean apps will work well on both color and monochrome terminals. +* **Cross Platform** - Windows, Mac, and Linux. Terminal drivers for Curses, [Windows Console](https://github.com/gui-cs/Terminal.Gui/issues/27), and the .NET Console mean apps will work well on both color and monochrome terminals. * **Keyboard and Mouse Input** - Both keyboard and mouse input are supported, including support for drag & drop. * **[Flexible Layout](https://gui-cs.github.io/Terminal.Gui/articles/overview.html#layout)** - Supports both *Absolute layout* and an innovative *Computed Layout* system. *Computed Layout* makes it easy to layout controls relative to each other and enables dynamic terminal UIs. * **Clipboard support** - Cut, Copy, and Paste of text provided through the [`Clipboard`](https://gui-cs.github.io/Terminal.Gui/api/Terminal.Gui/Terminal.Gui.Clipboard.html) class. * **[Arbitrary Views](https://gui-cs.github.io/Terminal.Gui/api/Terminal.Gui/Terminal.Gui.View.html)** - All visible UI elements are subclasses of the `View` class, and these in turn can contain an arbitrary number of sub-views. * **Advanced App Features** - The [Mainloop](https://gui-cs.github.io/Terminal.Gui/api/Terminal.Gui/Terminal.Gui.MainLoop.html) supports processing events, idle handlers, timers, and monitoring file descriptors. Most classes are safe for threading. -* **Reactive Extensions** - Use [reactive extensions](https://github.com/dotnet/reactive) and benefit from increased code readability, and the ability to apply the MVVM pattern and [ReactiveUI](https://www.reactiveui.net/) data bindings. See the [source code](https://github.com/migueldeicaza/gui.cs/tree/master/ReactiveExample) of a sample app in order to learn how to achieve this. +* **Reactive Extensions** - Use [reactive extensions](https://github.com/dotnet/reactive) and benefit from increased code readability, and the ability to apply the MVVM pattern and [ReactiveUI](https://www.reactiveui.net/) data bindings. See the [source code](https://github.com/gui-cs/Terminal.Gui/tree/master/ReactiveExample) of a sample app in order to learn how to achieve this. ### Keyboard Input Handling @@ -73,7 +73,7 @@ Apps can change key bindings using the `AddKeyBinding` API. ### Driver Model -**Terminal.Gui** has support for [ncurses](https://github.com/migueldeicaza/gui.cs/blob/master/Terminal.Gui/ConsoleDrivers/CursesDriver/CursesDriver.cs), [`System.Console`](https://github.com/migueldeicaza/gui.cs/blob/master/Terminal.Gui/ConsoleDrivers/NetDriver.cs), and a full [Win32 Console](https://github.com/migueldeicaza/gui.cs/blob/master/Terminal.Gui/ConsoleDrivers/WindowsDriver.cs) front-end. +**Terminal.Gui** has support for [ncurses](https://github.com/gui-cs/Terminal.Gui/blob/master/Terminal.Gui/ConsoleDrivers/CursesDriver/CursesDriver.cs), [`System.Console`](https://github.com/gui-cs/Terminal.Gui/blob/master/Terminal.Gui/ConsoleDrivers/NetDriver.cs), and a full [Win32 Console](https://github.com/gui-cs/Terminal.Gui/blob/master/Terminal.Gui/ConsoleDrivers/WindowsDriver.cs) front-end. `ncurses` is used on Mac/Linux/Unix with color support based on what your library is compiled with; the Windows driver supports full color and mouse, and an easy-to-debug `System.Console` can be used on Windows and Unix, but lacks mouse support. @@ -81,11 +81,11 @@ You can force the use of `System.Console` on Unix as well; see `Core.cs`. ## Showcase & Examples -* **[UI Catalog](https://github.com/migueldeicaza/gui.cs/tree/master/UICatalog)** - The UI Catalog project provides an easy to use and extend sample illustrating the capabilities of **Terminal.Gui**. Run `dotnet run --project UICatalog` to run the UI Catalog. -* **[Reactive Example](https://github.com/migueldeicaza/gui.cs/tree/master/ReactiveExample)** - A sample app that shows how to use `System.Reactive` and `ReactiveUI` with `Terminal.Gui`. The app uses the MVVM architecture that may seem familiar to folks coming from WPF, Xamarin Forms, UWP, Avalonia, or Windows Forms. In this app, we implement the data bindings using ReactiveUI `WhenAnyValue` syntax and [Pharmacist](https://github.com/reactiveui/pharmacist) — a tool that converts all events in a NuGet package into observable wrappers. -* **[Example (aka `demo.cs`)](https://github.com/migueldeicaza/gui.cs/tree/master/Example)** - Run `dotnet run` in the `Example` directory to run the simple demo. -* **[Standalone Example](https://github.com/migueldeicaza/gui.cs/tree/master/StandaloneExample)** - A trivial .NET core sample application can be found in the `StandaloneExample` directory. Run `dotnet run` in directory to test. -* **[F# Example](https://github.com/migueldeicaza/gui.cs/tree/master/FSharpExample)** - An example showing how to build a Terminal.Gui app using F#. +* **[UI Catalog](https://github.com/gui-cs/Terminal.Gui/tree/master/UICatalog)** - The UI Catalog project provides an easy to use and extend sample illustrating the capabilities of **Terminal.Gui**. Run `dotnet run --project UICatalog` to run the UI Catalog. +* **[Reactive Example](https://github.com/gui-cs/Terminal.Gui/tree/master/ReactiveExample)** - A sample app that shows how to use `System.Reactive` and `ReactiveUI` with `Terminal.Gui`. The app uses the MVVM architecture that may seem familiar to folks coming from WPF, Xamarin Forms, UWP, Avalonia, or Windows Forms. In this app, we implement the data bindings using ReactiveUI `WhenAnyValue` syntax and [Pharmacist](https://github.com/reactiveui/pharmacist) — a tool that converts all events in a NuGet package into observable wrappers. +* **[Example (aka `demo.cs`)](https://github.com/gui-cs/Terminal.Gui/tree/master/Example)** - Run `dotnet run` in the `Example` directory to run the simple demo. +* **[Standalone Example](https://github.com/gui-cs/Terminal.Gui/tree/master/StandaloneExample)** - A trivial .NET core sample application can be found in the `StandaloneExample` directory. Run `dotnet run` in directory to test. +* **[F# Example](https://github.com/gui-cs/Terminal.Gui/tree/master/FSharpExample)** - An example showing how to build a Terminal.Gui app using F#. * **[PowerShell's `Out-ConsoleGridView`](https://github.com/PowerShell/GraphicalTools/blob/master/docs/Microsoft.PowerShell.ConsoleGuiTools/Out-ConsoleGridView.md)** - `OCGV` sends the output from a command to an interactive table. * **[PoshRedisViewer](https://github.com/En3Tho/PoshRedisViewer)** - A compact Redis viewer module for PowerShell written in F# and Gui.cs * **[TerminalGuiDesigner](https://github.com/tznind/TerminalGuiDesigner)** - Cross platform view designer for building Terminal.Gui applications. @@ -96,7 +96,7 @@ You can force the use of `System.Console` on Unix as well; see `Core.cs`. * [Conceptual Documentation](https://gui-cs.github.io/Terminal.Gui/articles/index.html) * [API Documentation](https://gui-cs.github.io/Terminal.Gui/api/Terminal.Gui/Terminal.Gui.html) -See the [`Terminal.Gui/` README](https://github.com/migueldeicaza/gui.cs/tree/master/Terminal.Gui) for an overview of how the library is structured. The [Conceptual Documentation](https://gui-cs.github.io/Terminal.Gui/articles/index.html) provides insight into core concepts. +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. The [Conceptual Documentation](https://gui-cs.github.io/Terminal.Gui/articles/index.html) provides insight into core concepts. ### Sample Usage (This code uses C# 9.0 [Top-level statements](https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-9#top-level-statements).) @@ -211,13 +211,11 @@ dotnet add package Terminal.Gui * 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.Gui.sln` with Visual Studio 2019. -Building in `Release` requires the [git command line tool](https://git-scm.com/) (a dependency of the [MinVer](https://github.com/adamralph/minver#can-i-disable-minver) build tool) - ## Contributing -See [CONTRIBUTING.md](https://github.com/migueldeicaza/gui.cs/blob/master/CONTRIBUTING.md). +See [CONTRIBUTING.md](https://github.com/gui-cs/Terminal.Gui/blob/master/CONTRIBUTING.md). -Debates on architecture and design can be found in Issues tagged with [design](https://github.com/migueldeicaza/gui.cs/issues?q=is%3Aopen+is%3Aissue+label%3Adesign). +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%3Adesign). ## History @@ -227,6 +225,6 @@ The original **gui.cs** was a UI toolkit in a single file and tied to curses. Th A presentation of this was part of the [Retro.NET](https://channel9.msdn.com/Events/dotnetConf/2018/S313) talk at .NET Conf 2018 [Slides](https://tirania.org/Retro.pdf) -Release history can be found in the [Terminal.Gui.csproj](https://github.com/migueldeicaza/gui.cs/blob/master/Terminal.Gui/Terminal.Gui.csproj) file. +Release history can be found in the [Terminal.Gui.csproj](https://github.com/gui-cs/Terminal.Gui/blob/master/Terminal.Gui/Terminal.Gui.csproj) file. In 2019, 2020, and 2021, Charlie Kindel (https://github.com/tig), @BDisp (https://github.com/BDisp), and Thomas Nind (https://github.com/tznind) vastly extended, improved, polished and fixed gui.cs to what it is today. diff --git a/Terminal.Gui/ConsoleDrivers/WindowsDriver.cs b/Terminal.Gui/ConsoleDrivers/WindowsDriver.cs index a029a8d37d..5dbda0a446 100644 --- a/Terminal.Gui/ConsoleDrivers/WindowsDriver.cs +++ b/Terminal.Gui/ConsoleDrivers/WindowsDriver.cs @@ -655,7 +655,7 @@ internal void ShowWindow (int state) ShowWindow (thisConsole, state); } #endif - // See: https://github.com/migueldeicaza/gui.cs/issues/357 + // See: https://github.com/gui-cs/Terminal.Gui/issues/357 [StructLayout (LayoutKind.Sequential)] public struct CONSOLE_SCREEN_BUFFER_INFOEX { diff --git a/Terminal.Gui/Core/Application.cs b/Terminal.Gui/Core/Application.cs index 7332b994e1..c7baaa480f 100644 --- a/Terminal.Gui/Core/Application.cs +++ b/Terminal.Gui/Core/Application.cs @@ -901,7 +901,7 @@ static void ResetState () // Reset synchronization context to allow the user to run async/await, // as the main loop has been ended, the synchronization context from // gui.cs does no longer process any callbacks. See #1084 for more details: - // (https://github.com/migueldeicaza/gui.cs/issues/1084). + // (https://github.com/gui-cs/Terminal.Gui/issues/1084). SynchronizationContext.SetSynchronizationContext (syncContext: null); } diff --git a/Terminal.Gui/README.md b/Terminal.Gui/README.md index 28452ed4dc..e76a996ecc 100644 --- a/Terminal.Gui/README.md +++ b/Terminal.Gui/README.md @@ -43,10 +43,6 @@ dotnet-gitversion /updateprojectfiles dotnet build -c Release ``` -You can see the version in the `UICatalog` about box. - -![About Box](https://raw.githubusercontent.com/migueldeicaza/gui.cs/master/docfx/aboutbox.png) - ## Publishing a Release of Terminal.Gui 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 upstream repo. @@ -119,7 +115,7 @@ git push upstream v2.3.4 https://www.nuget.org/packages/Terminal.Gui -10) Add a new Release in Github: https://github.com/migueldeicaza/gui.cs/releases +10) Add a new Release in Github: https://github.com/gui-cs/Terminal.Gui/releases ## Nuget @@ -133,4 +129,4 @@ Miguel can hide defunct/old nuget packages. ## Contributing -See [CONTRIBUTING.md](https://github.com/migueldeicaza/gui.cs/blob/master/CONTRIBUTING.md). +See [CONTRIBUTING.md](https://github.com/gui-cs/Terminal.Gui/blob/master/CONTRIBUTING.md). diff --git a/Terminal.Gui/Terminal.Gui.csproj b/Terminal.Gui/Terminal.Gui.csproj index f004ec2a85..888bcc707b 100644 --- a/Terminal.Gui/Terminal.Gui.csproj +++ b/Terminal.Gui/Terminal.Gui.csproj @@ -62,8 +62,8 @@ Terminal.Gui MIT - https://github.com/migueldeicaza/gui.cs/ - https://github.com/migueldeicaza/gui.cs.git + https://github.com/gui-cs/Terminal.Gui/ + https://github.com/gui-cs/Terminal.Gui.git git true snupkg diff --git a/Terminal.Gui/Views/TableView.cs b/Terminal.Gui/Views/TableView.cs index c67439df70..74a8862bdf 100644 --- a/Terminal.Gui/Views/TableView.cs +++ b/Terminal.Gui/Views/TableView.cs @@ -11,7 +11,7 @@ namespace Terminal.Gui { /// /// View for tabular data based on a . /// - /// See TableView Deep Dive for more information. + /// See TableView Deep Dive for more information. /// public class TableView : View { @@ -1373,7 +1373,7 @@ private string GetRepresentation (object value, ColumnStyle colStyle) /// Describes how to render a given column in a including /// and textual representation of cells (e.g. date formats) /// - /// See TableView Deep Dive for more information. + /// See TableView Deep Dive for more information. /// public class ColumnStyle { @@ -1463,7 +1463,7 @@ public string GetRepresentation (object value) /// /// Defines rendering options that affect how the table is displayed. /// - /// See TableView Deep Dive for more information. + /// See TableView Deep Dive for more information. /// public class TableStyle { diff --git a/Terminal.Gui/Views/TreeView.cs b/Terminal.Gui/Views/TreeView.cs index d307d37484..61fa4520c2 100644 --- a/Terminal.Gui/Views/TreeView.cs +++ b/Terminal.Gui/Views/TreeView.cs @@ -14,7 +14,7 @@ namespace Terminal.Gui { /// /// Interface for all non generic members of /// - /// See TreeView Deep Dive for more information. + /// See TreeView Deep Dive for more information. /// public interface ITreeView { /// @@ -37,7 +37,7 @@ public interface ITreeView { /// Convenience implementation of generic for any tree were all nodes /// implement . /// - /// See TreeView Deep Dive for more information. + /// See TreeView Deep Dive for more information. /// public class TreeView : TreeView { @@ -56,7 +56,7 @@ public TreeView () /// Hierarchical tree view with expandable branches. Branch objects are dynamically determined /// when expanded using a user defined /// - /// See TreeView Deep Dive for more information. + /// See TreeView Deep Dive for more information. /// public class TreeView : View, ITreeView where T : class { private int scrollOffsetVertical; diff --git a/Terminal.Gui/Windows/Wizard.cs b/Terminal.Gui/Windows/Wizard.cs index 3219058b05..e19a14b270 100644 --- a/Terminal.Gui/Windows/Wizard.cs +++ b/Terminal.Gui/Windows/Wizard.cs @@ -365,7 +365,7 @@ public Wizard (ustring title) : base (title) //}; //Add (separator); - // BUGBUG: Space is to work around https://github.com/migueldeicaza/gui.cs/issues/1812 + // BUGBUG: Space is to work around https://github.com/gui-cs/Terminal.Gui/issues/1812 backBtn = new Button (Strings.wzBack) { AutoSize = true }; AddButton (backBtn); diff --git a/Terminal.sln b/Terminal.sln index 0f458fd0be..03b0011e98 100644 --- a/Terminal.sln +++ b/Terminal.sln @@ -2,8 +2,6 @@ Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio Version 17 VisualStudioVersion = 17.2.32427.441 MinimumVisualStudioVersion = 10.0.40219.1 -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Example", "Example\Example.csproj", "{B0A602CD-E176-449D-8663-64238D54F857}" -EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Terminal.Gui", "Terminal.Gui\Terminal.Gui.csproj", "{00F366F8-DEE4-482C-B9FD-6DB0200B79E5}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "UICatalog", "UICatalog\UICatalog.csproj", "{88979F89-9A42-448F-AE3E-3060145F6375}" @@ -12,6 +10,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "UnitTests", "UnitTests\Unit EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ReactiveExample", "ReactiveExample\ReactiveExample.csproj", "{44E15B48-0DB2-4560-82BD-D3B7989811C3}" EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Example", "Example\Example.csproj", "{B0A602CD-E176-449D-8663-64238D54F857}" +EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{E143FB1F-0B88-48CB-9086-72CDCECFCD22}" ProjectSection(SolutionItems) = preProject .gitignore = .gitignore @@ -30,6 +30,15 @@ Global Release|x86 = Release|x86 EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution + {88979F89-9A42-448F-AE3E-3060145F6375}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {88979F89-9A42-448F-AE3E-3060145F6375}.Debug|Any CPU.Build.0 = Debug|Any CPU + {88979F89-9A42-448F-AE3E-3060145F6375}.Debug|x86.ActiveCfg = Debug|Any CPU + {88979F89-9A42-448F-AE3E-3060145F6375}.Debug|x86.Build.0 = Debug|Any CPU + {88979F89-9A42-448F-AE3E-3060145F6375}.Release|Any CPU.ActiveCfg = Release|Any CPU + {88979F89-9A42-448F-AE3E-3060145F6375}.Release|Any CPU.Build.0 = Release|Any CPU + {88979F89-9A42-448F-AE3E-3060145F6375}.Release|x86.ActiveCfg = Release|Any CPU + {88979F89-9A42-448F-AE3E-3060145F6375}.Release|x86.Build.0 = Release|Any CPU + {B0A602CD-E176-449D-8663-64238D54F857}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {B0A602CD-E176-449D-8663-64238D54F857}.Debug|Any CPU.Build.0 = Debug|Any CPU {B0A602CD-E176-449D-8663-64238D54F857}.Debug|x86.ActiveCfg = Debug|Any CPU @@ -46,14 +55,7 @@ Global {00F366F8-DEE4-482C-B9FD-6DB0200B79E5}.Release|Any CPU.Build.0 = Release|Any CPU {00F366F8-DEE4-482C-B9FD-6DB0200B79E5}.Release|x86.ActiveCfg = Release|Any CPU {00F366F8-DEE4-482C-B9FD-6DB0200B79E5}.Release|x86.Build.0 = Release|Any CPU - {88979F89-9A42-448F-AE3E-3060145F6375}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {88979F89-9A42-448F-AE3E-3060145F6375}.Debug|Any CPU.Build.0 = Debug|Any CPU - {88979F89-9A42-448F-AE3E-3060145F6375}.Debug|x86.ActiveCfg = Debug|Any CPU - {88979F89-9A42-448F-AE3E-3060145F6375}.Debug|x86.Build.0 = Debug|Any CPU - {88979F89-9A42-448F-AE3E-3060145F6375}.Release|Any CPU.ActiveCfg = Release|Any CPU - {88979F89-9A42-448F-AE3E-3060145F6375}.Release|Any CPU.Build.0 = Release|Any CPU - {88979F89-9A42-448F-AE3E-3060145F6375}.Release|x86.ActiveCfg = Release|Any CPU - {88979F89-9A42-448F-AE3E-3060145F6375}.Release|x86.Build.0 = Release|Any CPU + {8B901EDE-8974-4820-B100-5226917E2990}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {8B901EDE-8974-4820-B100-5226917E2990}.Debug|Any CPU.Build.0 = Debug|Any CPU {8B901EDE-8974-4820-B100-5226917E2990}.Debug|x86.ActiveCfg = Debug|Any CPU diff --git a/UICatalog/README.md b/UICatalog/README.md index 02cf0ed0b3..91dbada2ac 100644 --- a/UICatalog/README.md +++ b/UICatalog/README.md @@ -10,11 +10,12 @@ UI Catalog is a comprehensive sample library for Terminal.Gui. It attempts to sa ## Motivation -The original `demo.cs` sample app for Terminal.Gui is neither good to showcase, nor does it explain different concepts. In addition, because it is built on a single source file, it has proven to cause friction when multiple contributors are simultaneously working on different aspects of Terminal.Gui. See [Issue #368](https://github.com/migueldeicaza/Terminal.Gui/issues/368) for more background. +The original `demo.cs` sample app for Terminal.Gui is neither good to showcase, nor does it explain different concepts. In addition, because it is built on a single source file, it has proven to cause friction when multiple contributors are simultaneously working on different aspects of Terminal.Gui. +See [Issue #368](https://github.com/giu-cs/Terminal.Gui/issues/368) for more background. # API Reference -* [UI Catalog API Reference](https://migueldeicaza.github.io/gui.cs/api/UICatalog/UICatalog.html) +* [UI Catalog API Reference](https://gui-cs.github.io/Terminal.Gui/api/UICatalog/UICatalog.html) ## How To Use @@ -127,4 +128,4 @@ For complete control, the `Init` and `Run` overrides can be implemented. The `ba - Use the `Bug Rero` Category for `Scnarios` that reproduce bugs. - Include the Github Issue # in the Description. - Once the bug has been fixed in `master` submit another PR to remove the `Scenario` (or modify it to provide a good regression test). -- Tag bugs or suggestions for `UI Catalog` as [`Terminal.Gui` Github Issues](https://github.com/migueldeicaza/gui.cs/issues) with "UICatalog: ". \ No newline at end of file +- Tag bugs or suggestions for `UI Catalog` as [`Terminal.Gui` Github Issues](https://github.com/gui-cs/Terminal.Gui/issues) with "UICatalog: ". \ No newline at end of file diff --git a/UICatalog/Scenarios/ListViewWithSelection.cs b/UICatalog/Scenarios/ListViewWithSelection.cs index 51602a4c05..057dcb6935 100644 --- a/UICatalog/Scenarios/ListViewWithSelection.cs +++ b/UICatalog/Scenarios/ListViewWithSelection.cs @@ -198,7 +198,7 @@ int GetMaxLengthItem () return maxLength; } - // A slightly adapted method from: https://github.com/migueldeicaza/gui.cs/blob/fc1faba7452ccbdf49028ac49f0c9f0f42bbae91/Terminal.Gui/Views/ListView.cs#L433-L461 + // A slightly adapted method from: https://github.com/gui-cs/Terminal.Gui/blob/fc1faba7452ccbdf49028ac49f0c9f0f42bbae91/Terminal.Gui/Views/ListView.cs#L433-L461 private void RenderUstr (ConsoleDriver driver, ustring ustr, int col, int line, int width, int start = 0) { int used = 0; diff --git a/UICatalog/UICatalog.cs b/UICatalog/UICatalog.cs index 222fbb7fac..895228942d 100644 --- a/UICatalog/UICatalog.cs +++ b/UICatalog/UICatalog.cs @@ -38,7 +38,7 @@ /// /// /// -/// See the project README for more details (https://github.com/migueldeicaza/gui.cs/tree/master/UICatalog/README.md). +/// See the project README for more details (https://github.com/gui-cs/Terminal.Gui/tree/master/UICatalog/README.md). /// /// namespace UICatalog { @@ -156,18 +156,16 @@ private static Scenario GetScenarioToRun () _baseColorScheme = Colors.Base; StringBuilder aboutMessage = new StringBuilder (); + aboutMessage.AppendLine (@"A comprehensive sample library for"); aboutMessage.AppendLine (@""); - aboutMessage.AppendLine (@"UI Catalog is a comprehensive sample library for Terminal.Gui"); - aboutMessage.AppendLine (@""); - aboutMessage.AppendLine (@" _______ _ _ _____ _ "); - aboutMessage.AppendLine (@" |__ __| (_) | | / ____| (_)"); - aboutMessage.AppendLine (@" | | ___ _ __ _ __ ___ _ _ __ __ _| || | __ _ _ _ "); - aboutMessage.AppendLine (@" | |/ _ \ '__| '_ ` _ \| | '_ \ / _` | || | |_ | | | | |"); - aboutMessage.AppendLine (@" | | __/ | | | | | | | | | | | (_| | || |__| | |_| | |"); - aboutMessage.AppendLine (@" |_|\___|_| |_| |_| |_|_|_| |_|\__,_|_(_)_____|\__,_|_|"); - aboutMessage.AppendLine (@""); - aboutMessage.AppendLine ($"Using Terminal.Gui Version: {FileVersionInfo.GetVersionInfo (typeof (Terminal.Gui.Application).Assembly.Location).FileVersion}"); + aboutMessage.AppendLine (@" _______ _ _ _____ _ "); + aboutMessage.AppendLine (@" |__ __| (_) | | / ____| (_) "); + aboutMessage.AppendLine (@" | | ___ _ __ _ __ ___ _ _ __ __ _| || | __ _ _ _ "); + aboutMessage.AppendLine (@" | |/ _ \ '__| '_ ` _ \| | '_ \ / _` | || | |_ | | | | | "); + aboutMessage.AppendLine (@" | | __/ | | | | | | | | | | | (_| | || |__| | |_| | | "); + aboutMessage.AppendLine (@" |_|\___|_| |_| |_| |_|_|_| |_|\__,_|_(_)_____|\__,_|_| "); aboutMessage.AppendLine (@""); + aboutMessage.AppendLine (@"https://github.com/gui-cs/Terminal.Gui"); _menu = new MenuBar (new MenuBarItem [] { new MenuBarItem ("_File", new MenuItem [] { @@ -176,9 +174,10 @@ private static Scenario GetScenarioToRun () new MenuBarItem ("_Color Scheme", CreateColorSchemeMenuItems()), new MenuBarItem ("Diag_nostics", CreateDiagnosticMenuItems()), new MenuBarItem ("_Help", new MenuItem [] { - new MenuItem ("_gui.cs API Overview", "", () => OpenUrl ("https://migueldeicaza.github.io/gui.cs/articles/overview.html"), null, null, Key.F1), - new MenuItem ("gui.cs _README", "", () => OpenUrl ("https://github.com/migueldeicaza/gui.cs"), null, null, Key.F2), - new MenuItem ("_About...", "About this app", () => MessageBox.Query (aboutMessage.Length + 2, 15, "About", aboutMessage.ToString(), "_Ok"), null, null, Key.CtrlMask | Key.A), + new MenuItem ("_gui.cs API Overview", "", () => OpenUrl ("https://gui-cs.github.io/Terminal.Gui/articles/overview.html"), null, null, Key.F1), + new MenuItem ("gui.cs _README", "", () => OpenUrl ("https://github.com/gui-cs/Terminal.Gui"), null, null, Key.F2), + new MenuItem ("_About...", + "About UI Catalog", () => MessageBox.Query ("About UI Catalog", aboutMessage.ToString(), "_Ok"), null, null, Key.CtrlMask | Key.A), }) }); @@ -587,7 +586,7 @@ int GetMaxLengthItem () return maxLength; } - // A slightly adapted method from: https://github.com/migueldeicaza/gui.cs/blob/fc1faba7452ccbdf49028ac49f0c9f0f42bbae91/Terminal.Gui/Views/ListView.cs#L433-L461 + // A slightly adapted method from: https://github.com/gui-cs/Terminal.Gui/blob/fc1faba7452ccbdf49028ac49f0c9f0f42bbae91/Terminal.Gui/Views/ListView.cs#L433-L461 private void RenderUstr (ConsoleDriver driver, ustring ustr, int col, int line, int width, int start = 0) { int used = 0; diff --git a/UnitTests/PosTests.cs b/UnitTests/PosTests.cs index 1359743ccb..b3efecf0be 100644 --- a/UnitTests/PosTests.cs +++ b/UnitTests/PosTests.cs @@ -548,7 +548,7 @@ public void PosSide_SetsValue () Assert.Equal ($"Pos.Combine(Pos.Combine(Pos.View(side={side}, target=View()({{X={testRect.X},Y={testRect.Y},Width={testRect.Width},Height={testRect.Height}}}))+Pos.Absolute(0)){(testInt < 0 ? '-' : '+')}Pos.Absolute({testInt}))", pos.ToString ()); } - // See: https://github.com/migueldeicaza/gui.cs/issues/504 + // See: https://github.com/gui-cs/Terminal.Gui/issues/504 [Fact] public void LeftTopBottomRight_Win_ShouldNotThrow () { diff --git a/UnitTests/README.md b/UnitTests/README.md index 27b7dcccdc..3f3731b09f 100644 --- a/UnitTests/README.md +++ b/UnitTests/README.md @@ -2,4 +2,4 @@ `Terminal.Gui` uses [xunit](https://xunit.net/) for automated unit tests run automatically with Github Actions. -See the [Testing wiki](https://github.com/migueldeicaza/gui.cs/wiki/Testing) for details on how to add more tests. +See the [Testing wiki](https://github.com/gui-cs/Terminal.Gui/wiki/Testing) for details on how to add more tests. diff --git a/UnitTests/WizardTests.cs b/UnitTests/WizardTests.cs index 06830785dd..8d629e91c4 100644 --- a/UnitTests/WizardTests.cs +++ b/UnitTests/WizardTests.cs @@ -222,7 +222,7 @@ public void Setting_Title_Works () var topRow = $"{d.ULDCorner} {title}{stepTitle} {new String (d.HDLine.ToString () [0], width - title.Length - stepTitle.Length - 4)}{d.URDCorner}"; var separatorRow = $"{d.VDLine}{new String (d.HLine.ToString () [0], width - 2)}{d.VDLine}"; - // Once this is fixed, revert to commented out line: https://github.com/migueldeicaza/gui.cs/issues/1791 + // Once this is fixed, revert to commented out line: https://github.com/gui-cs/Terminal.Gui/issues/1791 var buttonRow = $"{d.VDLine}{new String (' ', width - btnNext.Length - 2)}{btnNext}{d.VDLine}"; //var buttonRow = $"{d.VDLine}{new String (' ', width - btnNext.Length - 2)}{btnNext}{d.VDLine}"; var bottomRow = $"{d.LLDCorner}{new String (d.HDLine.ToString () [0], width - 2)}{d.LRDCorner}"; @@ -512,7 +512,7 @@ public void Navigate_GetLastStep_Works () [Fact, AutoInitShutdown] public void Finish_Button_Closes () { - // https://github.com/migueldeicaza/gui.cs/issues/1833 + // https://github.com/gui-cs/Terminal.Gui/issues/1833 var wizard = new Wizard (); var step1 = new Wizard.WizardStep ("step1") { }; wizard.AddStep (step1);