From 559aca01b2e0a75c76d5a9550b9a7df42eee177d Mon Sep 17 00:00:00 2001 From: mappu Date: Tue, 6 Aug 2024 13:06:50 +1200 Subject: [PATCH] doc: add COPYING, README, TODO --- COPYING | 19 +++++++++++++++++++ README.md | 10 ++++++++++ TODO | 24 ++++++++++++++++++++++++ 3 files changed, 53 insertions(+) create mode 100644 COPYING create mode 100644 README.md create mode 100644 TODO diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..759b213 --- /dev/null +++ b/COPYING @@ -0,0 +1,19 @@ +Copyright 2024 mappu +Copyright 2024 The MIQT developers + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the “Software”), to deal in the +Software without restriction, including without limitation the rights to use, +copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the +Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..a3da06b --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +# MIQT + +MIT-licensed Qt bindings for Go. + +Developed against Clang 14, Qt 5.15, Debian 12 + +## License + +- The Go bindings and tools in this repo are licensed under the MIT license +- You must also meet your Qt license obligations. diff --git a/TODO b/TODO new file mode 100644 index 0000000..69a7806 --- /dev/null +++ b/TODO @@ -0,0 +1,24 @@ +Phase zero + +- [X] Handwritten bindings + +Phase 1 + +- [X] Parse headers +- [ ] Generate types (QtCore, QtGui, QtWidgets only) +- [X] Rename package +- [ ] v0 Public release + +Phase 2 + +- [ ] Port examples from other Go Qt bindings +- [ ] `connect` +- [ ] Other Qt packages +- [ ] Document use for Windows/macOS/Linux + +Wishlist + +- [ ] Subclassing +- [ ] Custom Q_PROPERTY support +- [ ] uic implementation +- [ ] Use clang ast's `mangledName` to make a dlsym/LazyDLL cgo-free version