Browse Source

removed deb file

Charlie Kindel 4 years ago
parent
commit
cb4091108d
4 changed files with 6 additions and 12 deletions
  1. 2 0
      .gitignore
  2. 3 11
      CONTRIBUTING.md
  3. 1 1
      README.md
  4. BIN
      packages-microsoft-prod.deb

+ 2 - 0
.gitignore

@@ -16,3 +16,5 @@ docfx/api
 .vscode/
 
 demo.txt
+
+*.deb

+ 3 - 11
CONTRIBUTING.md

@@ -61,22 +61,14 @@ The [Microsoft .NET Framework Design Guidelines](https://docs.microsoft.com/en-u
 > 
 > ✔️ DO name event handlers (delegates used as types of events) with the "EventHandler" suffix, as shown in the following example:
 > 
-> public delegate void ClickedEventHandler(object sender, ClickedEventArgs e);
-> 
-> ✔️ DO use two parameters named sender and e in event handlers.
-> 
-> The sender parameter represents the object that raised the event. The sender parameter is typically of type object, even if it is possible to employ a more specific type.
-> 
 > ✔️ DO name event argument classes with the "EventArgs" suffix.
 
-We are not currently consistent along these lines in `Terminal.Gui` at all. This leads to friction for adopters and bugs. As we take on fixing this we use the following guidelines:
-
 1. We follow the naming guidelines provided in https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/names-of-type-members?redirectedfrom=MSDN
-2. We use the `Action<T>` idiom for internal APIs, not for public APIs. For public APIs we use the `event/EventHandler` model.
+2. We use the `event Action<T>` idiom.
 3. For public APIs, the class that can raise the event will implement:
    - A `virtual` event raising function, named as `OnEventToRaise`. Typical implementations will simply do a `EventToRaise?.Invoke(this, eventArgs)`.
-   - An `event` as in `public event EventHandler<EventToRaiseArgs> EventToRaise`
-   - Consumers of the event can do `theobject.EventToRaise += (sender, e) => {};`
+   - An `event` as in `public event Action<EventArgs> EventToRaise`
+   - Consumers of the event can do `theobject.EventToRaise += (args) => {};`
    - Sub-classes of the class implementing `EventToRaise` can override `OnEventToRaise` as needed.
 4. Where possible, a subclass of `EventArgs` should be provided and the old and new state should be included. By doing this, event handler methods do not have to query the sender for state.
 

+ 1 - 1
README.md

@@ -82,7 +82,7 @@ You can force the use of `System.Console` on Unix as well; see `Core.cs`.
 * **[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#.
-* **[Powershell Sample]()** - Shows how to build Terminal.Gui apps using Powershell.
+* **[Powershell Sample]()** - (Coming soon! See PR #952. Shows how to build Terminal.Gui apps using Powershell.
 * **PowerShell's Out-ConsoleGridView** - The [`Out-ConsoleGridView` PowerShell Cmdlet](https://github.com/PowerShell/GraphicalTools/blob/master/docs/Microsoft.PowerShell.ConsoleGuiTools/Out-ConsoleGridView.md) sends the output from a command to a grid view window where the output is displayed in an interactive table. sends the output from a command to a grid view window where the output is displayed in an interactive table, using Terminal.Gui. 
 
 ## Documentation

BIN
packages-microsoft-prod.deb