doc: add COPYING, README, TODO

This commit is contained in:
mappu 2024-08-06 13:06:50 +12:00
parent 64c2dca497
commit 559aca01b2
3 changed files with 53 additions and 0 deletions

19
COPYING Normal file
View File

@ -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.

10
README.md Normal file
View File

@ -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.

24
TODO Normal file
View File

@ -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