summaryrefslogtreecommitdiff
path: root/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'doc.go')
-rw-r--r--doc.go28
1 files changed, 13 insertions, 15 deletions
diff --git a/doc.go b/doc.go
index e8f94db..fb67777 100644
--- a/doc.go
+++ b/doc.go
@@ -1,22 +1,21 @@
/*
-
Package gui implements a abstraction layer for Go visual elements.
Definitions:
- * Toolkit: the underlying GUI library (MacOS gui, Windows gui, gtk, qt, etc)
- * Node: A binary tree of all the underlying widgets
+ - Toolkit: the underlying GUI library (MacOS gui, Windows gui, gtk, qt, etc)
+ - Node: A binary tree of all the underlying widgets
Principles:
- * Make code using this package simple to use
- * Hide complexity internally here
- * Isolate the GUI toolkit
- * Widget names should try to match [Wikipedia Graphical widget]
- * When in doubt, search upward in the binary tree
- * It's ok to guess. Try to do something sensible.
+ - Make code using this package simple to use
+ - Hide complexity internally here
+ - Isolate the GUI toolkit
+ - Widget names should try to match [Wikipedia Graphical widget]
+ - When in doubt, search upward in the binary tree
+ - It's ok to guess. Try to do something sensible.
-Debian Build
+# Debian Build
This worked on debian sid (mate-desktop) on 2023/12/03
I didn't record the dependances needed (gtk-dev)
@@ -61,21 +60,21 @@ consistant.
External Toolkits
- * andlabs - https://github.com/andlabs/ui
- * gocui - https://github.com/awesome-gocui/gocui
+ - andlabs - https://github.com/andlabs/ui
+ - gocui - https://github.com/awesome-gocui/gocui
The next step is to allow this to work against go-gtk and go-qt.
TODO: Add Fyne, WASM, native macos & windows, android and
hopefully also things like libSDL, faiface/pixel, slint
-Bugs
+# Bugs
"The author's idea of friendly may differ to that of many other people."
-- quote from the minimalistic window manager 'evilwm'
-References
+# References
Useful links and other
external things which might be useful
@@ -86,6 +85,5 @@ external things which might be useful
* [Federated git pull](https://github.com/forgefed/forgefed) Hopefully this will work for me with gitea
* [Github mirror](https://github.com/wit-go/gui) This repo on mirror. Hopefully I won't have to use this.
* [WIT GO projects](https://go.wit.com/) Attempt to model go.uber.org
-
*/
package gui