summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJeff Carr <[email protected]>2024-02-12 07:47:00 -0600
committerJeff Carr <[email protected]>2024-02-12 07:47:00 -0600
commitf2b66550181f2ba05c2e01353d874bbc26c02dd2 (patch)
tree573d48c8752e71f77bdf279bdaaa454a61d94364 /README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d9819e6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# The create GUI toolkit packages for debian
+
+This package will create a .deb package of the GUI toolkits binaries
+
+![Debian image](https://www.debian.org/logos/openlogo.svg)
+*[Debian logo][rf], licensed under [Creative Commons 3.0 Attributions license][cc3-by].*
+
+The package source files are distributed under the various licenses. Some are proprietary
+because the underlying OS is proprietary. Whenever possible, the Linux ones are GPL.
+
+#### Install the toolkits from source
+
+To build all the toolkits so you can build your own GUI applications:
+
+```go
+ go get -v go.wit.com/toolkits/debian
+ cd ~/go/src/toolkits/debian
+ make
+```
+To build the go-gui-toolkits .deb package:
+```go
+ go get go.wit.com/apps/go-deb@latest
+ go-deb go.wit.com/apps/go-gui-toolkits
+```
+
+This will put the debian package in your ~/incoming/ directory
+
+### Contributing
+
+To contribute, please refer to [go.wit.com](http://go.wit.com)
+
+[rf]: https://debian.org/
+[cc3-by]: https://creativecommons.org/licenses/by/3.0/