aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSamuli Piippo <samuli.piippo@qt.io>2021-04-07 15:36:04 +0300
committerSamuli Piippo <samuli.piippo@qt.io>2021-04-09 13:56:08 +0300
commita6f4deb96fc0c5bed9df59e8df389c09b2dcdf38 (patch)
treec13615169cbd03c85e2ab0cf1228683509974e9b /README.md
parent19b13f1e458b67839d1fb796b9facc2031925e6a (diff)
Update README
Change to markdown file, update information for Qt6 and the preferable way of initializing the build environment. Remove license header to make the file more readable. Pick-to: 6.1 6.0 Change-Id: I730f5eba376ce5337979bcd86287f1cb174e9ac2 Reviewed-by: Mikko Gronoff <mikko.gronoff@qt.io> Reviewed-by: Pasi Petäjäjärvi <pasi.petajajarvi@qt.io>
Diffstat (limited to 'README.md')
-rw-r--r--README.md55
1 files changed, 55 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..6aecd2bc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,55 @@
+Meta layer for Boot to Qt Software Stack
+========================================
+
+Boot to Qt (b2qt) is the reference distro used in Qt for Device Creation [1].
+It combines Poky, Qt and various BSP meta layers to provide an integrated
+solution for building device images and toolchains with the latest Qt version.
+
+Currently used dependencies, meta repositories and their revisions are shown in
+scripts/manifest.xml
+
+[1] http://www.qt.io/qt-for-device-creation/
+
+Sources
+-------
+
+Git: git://code.qt.io/yocto/meta-boot2qt
+Web: http://code.qt.io/cgit/yocto/meta-boot2qt.git
+Gerrit: https://codereview.qt-project.org/#/admin/projects/yocto/meta-boot2qt
+
+Contributing
+------------
+
+To contribute to this layer you should submit the patches for review using
+Qt Gerrit (https://codereview.qt-project.org).
+
+More information about Qt Gerrit and how to use it:
+https://wiki.qt.io/Gerrit_Introduction
+https://wiki.qt.io/Setting_up_Gerrit
+
+Layer maintainers
+-----------------
+
+Samuli Piippo <samuli.piippo@qt.io>
+
+Setting up build environment
+----------------------------
+
+Use the Google repo tool to initialize the Yocto environment:
+
+ cd <BuildDir>
+ repo init -u git://code.qt.io/yocto/boot2qt-manifest -m <manifest>
+ repo sync
+
+Where manifest is one of the XML manifest files available in the
+https://code.qt.io/cgit/yocto/boot2qt-manifest.git/tree/ repository.
+A separate manifest file is available for each release and all the
+development branches have manifests that follow the latest changes.
+
+If you have already cloned the meta-boot2qt repository, you can alternatively
+use the `b2qt-init-build-env` script to initialize the build environment:
+
+ ./b2qt-init-build-env init --device <name>
+
+For more information about using Boot to Qt, see:
+https://doc.qt.io/QtForDeviceCreation/b2qt-index.html