From 561111c46f9d67e9e7cee35392479c21bfd8fdc1 Mon Sep 17 00:00:00 2001 From: Miguel de Icaza Date: Thu, 8 Feb 2018 22:52:07 -0500 Subject: [PATCH] Update README --- README.md | 32 ++++++++++++++++++++++++++------ TODO.md | 7 ------- 2 files changed, 26 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 7be6cfbc6..68ad672e8 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,32 @@ It is an updated version of [gui.cs](http://tirania.org/blog/archive/2007/Apr-16.html) that I wrote for [mono-curses](https://github.com/mono/mono-curses) in 2007. -The toolkit contains various controls (labesl, text entry, buttons, -radio buttons, checkboxes, dialog boxes, windows, menus) for building -text user interfaces, a main loop, is designed to work on Curses and -the [Windows -Console](https://github.com/migueldeicaza/gui.cs/issues/27), works -well on both color and monochrome terminals and has mouse support on +The toolkit contains various controls for building text user interfaces: + +* [Buttons](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.Button.html) +* [Labels](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.Label.html) +* [Text entry](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.TextField.html) +* [Radio buttons](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.RadioGroup.html) +* [Checkboxes](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.CheckBox.html) +* [Dialog boxes](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.Dialog.html) + * [Message boxes](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.MessageBox.html) +* [Windows](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.Window.html) +* [Menus](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.MenuBar.html) +* [ListViews](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.ListView.html) +* [Frames](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.FrameView.html) +* [Scroll views](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.ScrollView.html) and [Scrollbars](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.ScrollBarView.html) + +All visible UI elements are subclasses of the +[View](https://migueldeicaza.github.io/gui.cs/api/Terminal.Gui/Terminal.Gui.View.html), +and these in turn can contain an arbitrary number of subviews. + +It comes with a +[mainloop](https://migueldeicaza.github.io/gui.cs/api/Mono.Terminal/Mono.Terminal.MainLoop.html) +to process events, process idle handlers, timers and monitoring file +descriptors. + +It is designed to work on Curses and the [Windows Console](https://github.com/migueldeicaza/gui.cs/issues/27), +works well on both color and monochrome terminals and has mouse support on terminal emulators that support it. # API Documentation diff --git a/TODO.md b/TODO.md index 261e11061..166936357 100644 --- a/TODO.md +++ b/TODO.md @@ -46,10 +46,3 @@ Will at least need the protocol for sizing For now it is split, in case we want to introduce formal view controllers. But the design becomes very ugly. -# Mono-Curses - -The only missing feature in Mono-Curses that still relies on a native library -is to fetch the OS SIGTSTP signal, we could hardcode this value if we had -a way of detecting the host operating system and architecture, and just hardcode -the value based on this. -