{"id":13415419,"url":"https://github.com/qmlbook/qmlbook","last_synced_at":"2025-05-15T11:01:50.899Z","repository":{"id":44434148,"uuid":"11542228","full_name":"qmlbook/qmlbook","owner":"qmlbook","description":"The source code for the upcoming qml book","archived":false,"fork":false,"pushed_at":"2023-06-02T17:07:28.000Z","size":23967,"stargazers_count":2561,"open_issues_count":91,"forks_count":594,"subscribers_count":193,"default_branch":"master","last_synced_at":"2025-04-13T06:21:04.306Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://qmlbook.github.io/","language":"Batchfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qmlbook.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.code","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2013-07-20T04:51:47.000Z","updated_at":"2025-04-07T04:35:38.000Z","dependencies_parsed_at":"2024-01-13T15:49:45.414Z","dependency_job_id":null,"html_url":"https://github.com/qmlbook/qmlbook","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qmlbook%2Fqmlbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qmlbook%2Fqmlbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qmlbook%2Fqmlbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qmlbook%2Fqmlbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qmlbook","download_url":"https://codeload.github.com/qmlbook/qmlbook/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254328384,"owners_count":22052632,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-30T21:00:48.499Z","updated_at":"2025-05-15T11:01:45.875Z","avatar_url":"https://github.com/qmlbook.png","language":"Batchfile","funding_links":[],"categories":["QML","Batchfile","HarmonyOS","Uncategorized"],"sub_categories":["Windows Manager","Uncategorized"],"readme":"QmlBook Project\n====================\n\n[![Join the chat at https://gitter.im/qmlbook/qmlbook](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/qmlbook/qmlbook?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge) [![Build Status](https://travis-ci.org/qmlbook/qmlbook.svg?branch=master)](https://travis-ci.org/qmlbook/qmlbook)\n\nThis 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.\n\nThe code examples are licensed under the BSD license. \n\n* Book License: http://creativecommons.org/licenses/by-nc/4.0/\n* Source Code Examples License: http://en.wikipedia.org/wiki/BSD_licenses\n\nDependencies\n============\n\n* git (http://git-scm.com/) - scm tool\n* sphinx (http://sphinx.pocoo.org/) - book engine\n    * sphinx-bootstrap-theme (https://github.com/ryan-roemer/sphinx-bootstrap-theme) - bootstrap HTML theme\n* graphviz (http://www.graphviz.org/) - diagram tool\n* shorty (https://github.com/qmlbook/shorty) - QML screenshot tool\n\nSetup\n=====\n\nIdeally you use a python virtual environment and install the dependencies their inside.\n\n    cd qmlbook\n    virtualenv -p python3 venv\n    source venv/bin/activate\n\nThis gives you a clean python3 setup. Now you need to install the dependencies:\n    \n    source venv/bin/activate\n    pip install -r requirements.txt\n\nThis will install all listed packages from the requirements document.\n\nFor rebuilding the documentation we also use a screen shot tool called shorty. It takes a screenshot from a running Qt application. To build it please clone the repo and build the tool with a decent Qt version.\n\n    git clone git@github.com:qmlbook/shorty.git\n    cd shorty\n    mkdir build \u0026\u0026 cd build\n    qmake .. \u0026\u0026 make\n\nMake sure shorty is on your search path, when \n\nBuilding\n========\n\nSimply use the `Makefile` provided. It 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.\n\nScreenshots\n===========\n\nScreenshots 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.\n\nContributions\n=============\n\nWe 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`.\n\nWe 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.\n\nLicensing\n=========\n\nIn general, the text of this book is available under a Creative Commons \nAttribution-NonCommercial-ShareAlike 4.0. Please refer to `LICENSE.text` for\nthe actual legaleese wording of the license. This applies to:\n\n* All `rst` files.\n* All illustrations appearing in the text.\n\nThe examples assoiated with the book are made available under a three clause\nBSD license, see `LICENSE.code` for the actual license text. This is to make it\npossible for readers to take inspiration from, or even copy and paste from the\nexamples without any fear of licensing issues. This applies to:\n\n* All example source code, i.e. `qml`-files and `js`-files used in examples.\n* Graphics used in the examples.\n\nExceptions\n----------\n\nThis section lists material that does not fall under the general licensing\nrules described above. This list is explicit and overrides any other licensing\ninformation.\n\n* `modelview/src/delegates/images/earth.jpeg`\n    - Image credit: NASA/JPL\n    - Source: http://photojournal.jpl.nasa.gov/catalog/PIA00232\n* `modelview/src/delegates/images/jupiter.jpeg`\n    - Image credit: NASA/Freddy Willems, Amateur Astronomer\n    - Source: http://photojournal.jpl.nasa.gov/catalog/PIA14411\n* `modelview/src/delegates/images/mars.jpeg`\n    - Image credit: NASA/JPL-Caltech\n    - Source: http://photojournal.jpl.nasa.gov/catalog/PIA14293\n* `modelview/src/delegates/images/mercury.jpeg`\n    - Image credit: NASA/Johns Hopkins University Applied Physics\n      Laboratory/Carnegie Institution of Washington\n    - Source: http://photojournal.jpl.nasa.gov/catalog/PIA14551\n* `modelview/src/delegates/images/venus.jpeg`\n    - Image credit: NASA/JPL\n    - Source: http://photojournal.jpl.nasa.gov/catalog/PIA00072\n* `multimedia/src/sound-effects/swosh.wav`\n    - License: CC0\n    - Source: http://www.freesound.org/people/qubodup/sounds/60026/\n* `multimedia/src/sound-effects/beep.wav`\n    - License: CC0\n    - Source:  http://www.freesound.org/people/reecord2/sounds/96063/\n* `controls/src/imageviewer-mobile/images/baseline-menu-24px.svg`\n    - License: Apache-2.0\n    - Source: https://material.io/tools/icons/?icon=menu\u0026style=baseline\n* `controls/src/imageviewer-all/images/baseline-menu-24px.svg`\n    - License: Apache-2.0\n    - Source: https://material.io/tools/icons/?icon=menu\u0026style=baseline\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqmlbook%2Fqmlbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqmlbook%2Fqmlbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqmlbook%2Fqmlbook/lists"}