diff --git a/README.md b/README.md index 56a151e83..c90777e3a 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,8 @@ dotnet run _The Documentation matches the most recent Nuget release from the `main` branch ([![Version](https://img.shields.io/nuget/v/Terminal.Gui.svg)](https://www.nuget.org/packages/Terminal.Gui))_ +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. + ## Features * **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. @@ -52,17 +54,9 @@ descriptors. Most classes are safe for threading. ## Showcase & Examples -* **[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. -* **[C# Example](https://github.com/gui-cs/Terminal.Gui/tree/master/Example)** - Run `dotnet run` in the `Example` directory to run the C# Example. -* **[F# Example](https://github.com/gui-cs/Terminal.Gui/tree/master/FSharpExample)** - An example showing how to build a Terminal.Gui app using F#. -* **[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. -* **[PowerShell's `Out-ConsoleGridView`](https://github.com/PowerShell/GraphicalTools)** - `OCGV` sends the output from a command to an interactive table. -* **[F7History](https://github.com/gui-cs/F7History)** - Graphical Command History for PowerShell (built on PowerShell's `Out-ConsoleGridView`). -* **[PoshRedisViewer](https://github.com/En3Tho/PoshRedisViewer)** - A compact Redis viewer module for PowerShell written in F#. -* **[PoshDotnetDumpAnalyzeViewer](https://github.com/En3Tho/PoshDotnetDumpAnalyzeViewer)** - dotnet-dump UI module for PowerShell. -* **[TerminalGuiDesigner](https://github.com/tznind/TerminalGuiDesigner)** - Cross platform view designer for building Terminal.Gui applications. - -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. +**Terminal.Gui** can be used with any .Net language to create feature rich and robust applications. +[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! ## Sample Usage in C# diff --git a/Showcase.md b/Showcase.md new file mode 100644 index 000000000..158360425 --- /dev/null +++ b/Showcase.md @@ -0,0 +1,25 @@ +# Showcase # + +* **[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. + ![Sample app](docfx/images/sample.gif) + ⠀ +* **[PowerShell's `Out-ConsoleGridView`](https://github.com/PowerShell/GraphicalTools)** - `OCGV` sends the output from a command to an interactive table. + ![OutConsoleGridView.png](docfx/images/OutConsoleGridView.png) + ⠀ +* **[F7History](https://github.com/gui-cs/F7History)** - Graphical Command History for PowerShell (built on PowerShell's `Out-ConsoleGridView`). + ![F7History.gif](docfx/images/F7History.gif) + ⠀ +* **[PoshRedisViewer](https://github.com/En3Tho/PoshRedisViewer)** - A compact Redis viewer module for PowerShell written in F#. + ![PoshRedisViewer.png](docfx/images/PoshRedisViewer.png) + ⠀ +* **[PoshDotnetDumpAnalyzeViewer](https://github.com/En3Tho/PoshDotnetDumpAnalyzeViewer)** - dotnet-dump UI module for PowerShell. + ![PoshDotnetDumpAnalyzerViewer.png](docfx/images/PoshDotnetDumpAnalyzerViewer.png) + ⠀ +* **[TerminalGuiDesigner](https://github.com/tznind/TerminalGuiDesigner)** - Cross platform view designer for building Terminal.Gui applications. + ![TerminalGuiDesigner.gif](docfx/images/TerminalGuiDesigner.gif) + +# Examples # + +* **[C# Example](https://github.com/gui-cs/Terminal.Gui/tree/master/Example)** - Run `dotnet run` in the `Example` directory to run the C# Example. +* **[F# Example](https://github.com/gui-cs/Terminal.Gui/tree/master/FSharpExample)** - An example showing how to build a Terminal.Gui app using F#. +* **[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. \ No newline at end of file diff --git a/Terminal.sln b/Terminal.sln index 5f66cd27c..dc87763bf 100644 --- a/Terminal.sln +++ b/Terminal.sln @@ -25,6 +25,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution .github\workflows\publish.yml = .github\workflows\publish.yml README.md = README.md testenvironments.json = testenvironments.json + Showcase.md = Showcase.md EndProjectSection EndProject Global diff --git a/docfx/images/F7History.gif b/docfx/images/F7History.gif new file mode 100644 index 000000000..e00ba5bcb Binary files /dev/null and b/docfx/images/F7History.gif differ diff --git a/docfx/images/OutConsoleGridView.png b/docfx/images/OutConsoleGridView.png new file mode 100644 index 000000000..954ed7b24 Binary files /dev/null and b/docfx/images/OutConsoleGridView.png differ diff --git a/docfx/images/PoshDotnetDumpAnalyzerViewer.png b/docfx/images/PoshDotnetDumpAnalyzerViewer.png new file mode 100644 index 000000000..01c8321fb Binary files /dev/null and b/docfx/images/PoshDotnetDumpAnalyzerViewer.png differ diff --git a/docfx/images/PoshRedisViewer.png b/docfx/images/PoshRedisViewer.png new file mode 100644 index 000000000..b37caff2f Binary files /dev/null and b/docfx/images/PoshRedisViewer.png differ diff --git a/docfx/images/TerminalGuiDesigner.gif b/docfx/images/TerminalGuiDesigner.gif new file mode 100644 index 000000000..cfc71f940 Binary files /dev/null and b/docfx/images/TerminalGuiDesigner.gif differ