From fa90c7f7e9de3a16ad04fbdca6a9664594df9aba Mon Sep 17 00:00:00 2001 From: mfreiholz Date: Fri, 19 Feb 2016 12:41:15 +0100 Subject: [PATCH] Updates README, adds license. --- README.md | 60 +++++++++++++++++++++++++++++----------------------- license.png | Bin 0 -> 1229 bytes 2 files changed, 34 insertions(+), 26 deletions(-) create mode 100644 license.png diff --git a/README.md b/README.md index 6114d7c..fdd3466 100644 --- a/README.md +++ b/README.md @@ -6,28 +6,43 @@ Basic usage of QWidgets an QLayouts and using basic styles as much as possible. ![Layout of widgets](preview01.png) ![Dropping widgets](preview02.png) -## Tested with - Requirements -**Windows** -- \>= Qt 5.5, VC12 or MinGW -- \>= Qt 4.5.3 VC9 - *not as good...* - -**Linux** -- Not yet tested +## Tested Compatible Environments +- Windows 10 / Qt 5.5.1 / VC12 +- Windows 10 / Qt 5.5.1 / MinGW +- Windows 10 / Qt 4.5.3 / VC9 +- Ubuntu 15.10 ## Build Open the `build.pro` with QtCreator and start the build, that's it. +You can run the demo project and test it yourself. ## Release & Development -The master branch is not guaranteed to be stable or does even build, since it is the main working branch. -If you want a version that builds you should always use a release/beta tag. +The `master` branch is not guaranteed to be stable or does not even build, since it is the main working branch. +If you want a version that builds, you should always use a release/beta tag. -## Notes -- *SectionContent* class may safe a "size-type" property, which defines how the size of the widget should be handled. - - PerCent: Resize in proportion to other widgets. - - Fixed: Width or height are fixed (based on orientation). +## Developers +[Manuel Freiholz](https://mfreiholz.de), Project Maintainer -## TODOs -Sorted by priority +## License information +![WTFPL](license.png) + +This projects uses the [WTFPL license](http://www.wtfpl.net/) +(Do **W**hat **T**he **F**uck You Want To **P**ublic **L**icense) + +Using it? Let us know by creating a [new issue](https://github.com/mfreiholz/qt-docks/issues/new) (You don't have to, of course). + +## Credits +- Drop indicator images from [Code Project Article](http://www.codeproject.com/Articles/140209/Building-a-Docking-Window-Management-Solution-in-W) + +## ToDo List & Changelog +Items sorted by priority + +### Beta 0.2 +- [ ] It would be easier when the SectionTitleWidget and SectionContentWidget are created inside the "SectionContent::newSectionContent(..)" method. + This would make sure, that those two objects always exists. +- [ ] `ContainerWidget::showSectionContent` needs to insert the SC at the correct preferred position of SW +- [ ] Empty splitters, if only 2 or 1 items are in container +- [ ] Restore: Handle out-of-screen geometry for floating widgets ### Beta 0.1 - [x] Improve FloatingWidget (Remove maximize button, only support close-button which hides the widget) @@ -39,11 +54,6 @@ Sorted by priority - [x] Clean up of unused e.g. count()<=1 QSplitters doesn't work well #BUG - [x] Show close button on right corner of SectionWidget. How to safe last section position? - [x] Serialize state of `_hiddenSectionContents` -- [ ] It would be easier when the SectionTitleWidget and SectionContentWidget are created inside the "SectionContent::newSectionContent(..)" method. - This would make sure, that those two objects always exists. -- [ ] `ContainerWidget::showSectionContent` needs to insert the SC at the correct preferred position of SW -- [ ] Empty splitters, if only 2 or 1 items are in container -- [ ] Restore: Handle out-of-screen geometry for floating widgets ### Some day... - [ ] Drop indicator images should be fully visible over the DropOverlay rectangle @@ -51,9 +61,7 @@ Sorted by priority - [ ] API: Make it possible to use custom drop images - [ ] API: Add possibility to make a SectionContent element floatable (`ContainerWidget::setFloating(SectionContent*)`?) -## Credits -- Drop indicator images from: - http://www.codeproject.com/Articles/140209/Building-a-Docking-Window-Management-Solution-in-W - -## License -Not sure yet... It's in development status anyway. \ No newline at end of file +## Notes +- *SectionContent* class may safe a "size-type" property, which defines how the size of the widget should be handled. + - PerCent: Resize in proportion to other widgets. + - Fixed: Width or height are fixed (based on orientation). \ No newline at end of file diff --git a/license.png b/license.png new file mode 100644 index 0000000000000000000000000000000000000000..7355c10d00fc299635cb9dc8238e33a4690dff1a GIT binary patch literal 1229 zcmV;;1Ty=HP)dwEQhfH@~3+58gfRymRmUynD|% z_gR4WD}O9O0O?({SIrBbY0w~jq~ z_E1|}OL=)YpFe+Qe0-clA_0J9S)4m}jw@HLP*G7)a_}t6;s?KZdHM3CjvP6nAFEQw zjvdq8yLXkzWaPT8JkQhj@89+8*)v_edR4b>-O|+5l#0coJkL|1P|(=em@Z$wtg5Oi z0kSMh-QC@iq(ma2jT<-m{{PRH=2xA3fW{b|KY!jgICbij#>dAcNvTvy$z)Q=WKzZ$ zNs{MzKKQR+zxvN-W@coJ(Ty87v}w~O0Sbje8Xg{&B%L{PrZfS*di6@-a9DsMk%&e{ zMkGnY!^1js=#V0jh)$k7sdPH6pXK)L+loXYibNv1c=4h<&yz7m?d|P;hZinfkR-i$ z@uD;V-n@BJfk42YtT9H$7hGK$4ws;sOOplCFz z$;nAcQam2_KT3Uly{4z97kB(8gI&^IPL|XEtotv&e=?@PLO`6Dn7|l=ZQC3^d>G5J zC>D#1jg9$1bLY;T%+1Zw+uO_O)2BIm_AK#uoNzeI=FOV{`1tW7$z&3MXf(>MUAqAI z@ZkfWK7CsCAifaD7vC>#FQ;3aG*>DC0MGOI^5qKvwr#V0`*r~4=H|#`G61Yuvxe&G zY5_Qw6e1iB128>3&D*zc0obx-3tP8tU2)B|+FNkJ*Gk|@l47x# zU!yfQH~ZQ4`Sa&Gc<`VfJT1!-pr)oKg+ifUf@^now_oa9zkXf8U{HWsTU$#z3+Hk< zoj7sAH|Xf-@IgF&{8(*mZQ8wixAyPfuS=IM>HYinx^w4_jvqg+Xf&$E#zyt__R4V_ zNz#)iPt?%RAV9WltFN!GwCg}gx_9rMwr$%spPmB&wYRq`kx0lGquJS6rPFCmO-(7E z&np&-X<}kRGcz+vrBcdfvoglWaU2Z{45+cOaY^};&*w|>Bx3z&`1`r1r-#nYPKw1M z01XWdw6wIackfC>k?eE5)THVeSf rqer=R?Hcv<^(A>0w*LN&S(*F;hL@=Z-KcWA00000NkvXXu0mjfju2HF literal 0 HcmV?d00001