Skip to content

Commit becace5

Browse files
authored
Updated readme noting module deprecation (#170)
1 parent 334f1a4 commit becace5

File tree

2 files changed

+17
-13
lines changed

2 files changed

+17
-13
lines changed

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
1-
# GraphicalTools
1+
# GraphicalTools - `Out-ConsoleGridView`
22

3-
The GraphicalTools repo contains `Microsoft.PowerShell.ConsoleGuiTools`: a
4-
module that provides console-based GUI experiences based on
3+
The GraphicalTools repo contains the `Out-ConsoleGridView`
4+
PowerShell Cmdlet providing console-based GUI experiences based on
55
[Terminal.Gui (gui.cs)](https://github.com/migueldeicaza/gui.cs).
66

7-
Note that a module named `Microsoft.PowerShell.GraphicalTools` used to be built
8-
and published out of this repo, but per [#101](https://github.com/PowerShell/GraphicalTools/issues/101)
9-
it is deprecated and unmaintained until such time that it can be rewritten on
10-
top of [.NET MAUI](https://devblogs.microsoft.com/dotnet/introducing-net-multi-platform-app-ui/).
7+
_Note:_ A module named `Microsoft.PowerShell.GraphicalTools` used to be built and published out of this repo, but per [#101](https://github.com/PowerShell/GraphicalTools/issues/101) it is deprecated and unmaintained until such time that it can be rewritten on top of [.NET MAUI](https://devblogs.microsoft.com/dotnet/introducing-net-multi-platform-app-ui/).
118

129
## Installation
1310

@@ -23,6 +20,15 @@ to view and filter objects graphically.
2320

2421
![screenshot of Out-ConsoleGridView](docs/Microsoft.PowerShell.ConsoleGuiTools/ocgv.gif)
2522

23+
### Examples
24+
25+
Get a process ID:
26+
```powershell
27+
gps | ocgv -OutputMode Single
28+
```
29+
30+
See the [F7 History](https://github.com/gui-cs/F7History) script to show the PowerShell command history when F7 is pressed.
31+
2632
## Development
2733

2834
### 1. Install PowerShell 7.2+
@@ -93,15 +99,13 @@ to learn more.
9399

94100
## (Deprecated) Microsoft.PowerShell.GraphicalTools Architecture
95101

96-
Due to the quirks of the PowerShell threading implementation, the design of
97-
GUIs in this application are non-standard. The cmdlet invokes an Avalonia
98-
application as a separate process to guarantee the GUI is running on the main
99-
thread. Graphical tools therefore consists of 3 .NET Projects.
102+
`GraphicalTools` consists of 2 .NET Projects:
100103

101-
- Microsoft.PowerShell.GraphicalTools - Cmdlet implementations
102-
- OutGridView.Gui - Implementation of the Out-GridView window
104+
- ConsoleGuiTools - Cmdlet implementation for Out-ConsoleGridView
103105
- OutGridView.Models - Contains data contracts between the GUI & Cmdlet
104106

107+
_Note:_ Previously, GraphicalTools also included the Avalonia-based `Out-GridView` which was implemented in `.\Microsoft.PowerShell.GraphicalTools` and `.\OutGridView.Gui`. These components have been deprecated (see note above).
108+
105109
## Maintainers
106110

107111
- [Andrew Schwartzmeyer](https://andschwa.com) - [@andschwa](https://github.com/andschwa)
-1.61 MB
Loading

0 commit comments

Comments
 (0)