The source code for the upcoming qml book
QML C++ Python Makefile Batchfile QMake Other
Latest commit 6b74cf0 May 4, 2016 @e8johan e8johan Merge pull request #95 from vipconsult/master
Fixed typo - MousArea -> MouseArea
Permalink
Failed to load latest commit information.
_extensions cleaned up the sphinx configuration file and changed theme to simplex… Mar 19, 2016
_images added screenshots to ch05. Mar 1, 2015
_templates Fix typo Jul 3, 2015
assets fixed issues with asset path May 12, 2015
de Massive update for enabling localisation. Changed default folder to e… Mar 15, 2015
en Update index.rst May 3, 2016
images moved common images to images folder from assets folder Feb 28, 2015
it improve it/ch01; change book it title Mar 21, 2015
pages Added the feedback page Oct 24, 2014
pt Chapter 1 in Portuguese Apr 17, 2015
.gitignore ignored qt help files and qmlproject user files Mar 19, 2016
CONTRIBUTING.md Updated contribution guideline Mar 11, 2015
LICENSE.code Added BSD license for examples Oct 21, 2014
LICENSE.text Added BSD license for examples Oct 21, 2014
Makefile Adding Makefile Oct 21, 2014
QmlBook.sketch Added the missing reference to the objects graphics (triangle, circle… Mar 21, 2016
README.md Updated contribution guideline Mar 11, 2015
conf.py Fixes #74 Broken Link. With my alias I can only access a page not a f… Mar 22, 2016
fabfile.py removed travis as Qt5.4 is more difficult to support Feb 28, 2015
index.rst Updated chapter number for PDF output by removing the toplevel placeh… May 12, 2015
logo.jpg Placeholders for media that is under license review Oct 21, 2014
make-screenshots.sh Added chapter 6 assets and related licensing information. Oct 21, 2014
make.bat Added make.bat (Windows equivalent to Makefile) Oct 21, 2014
pavement.py - fixed some wording in the getting started section Mar 21, 2016

README.md

QmlBook Project

Join the chat at https://gitter.im/qmlbook/qmlbook

This is the source code for the QML book contents (http://qmlbook.org). It is licensed under the Creative Commons Attribution-Non Commercial-Share Alike 4.0 license. We hope you enjoy it and we hope it helps you to learn Qt5.

The code examples are licensed under the BSD license.

Dependencies

Building

Simply use the Makefile provided. I supports a number of targets. We regularly build html, singlehtml and latexpdf, so these aught to work out of the box. The resulting files will end up in the _build directory.

Screenshots

Screenshots are used by the screenshots.qml files located inside each chapter directory. This relies on the shorty utility . Simply run make-screenshots.sh to automatically invoke shorty on all screenshots.qml files in the source tree.

Contributions

We greatly appreciate any contributions to this project. Feel free to submit pull requests with fixes or additional contents. When contributing, please add your name to the list of contributors in the pages/contributors.rst file. Also, if contributing a chapter, add your self as the sectionauthor.

We only accept contributions under a CLA, see CONTRIBUTING.md. This is because we, the original authors, want to ensure that we say yes if approached by someone willing to turn this material into a book made from dead trees.

Licensing

In general, the text of this book is available under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0. Please refer to LICENSE.text for the actual legaleese wording of the license. This applies to:

  • All rst files.
  • All illustrations appearing in the text.

The examples assoiated with the book are made available under a three clause BSD license, see LICENSE.code for the actual license text. This is to make it possible for readers to take inspiration from, or even copy and paste from the examples without any fear of licensing issues. This applies to:

  • All example source code, i.e. qml-files and js-files used in examples.
  • Graphics used in the examples.

Exceptions

This section lists material that does not fall under the general licensing rules described above. This list is explicit and overrides any other licensing information.