noteuclid/qt-wgpu-skel
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add usage notes

Browse Source
This commit is contained in:
numzero 2026-04-03 14:57:51 +03:00
parent 3e713b13a8
commit 24f3bc5d71
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -3,3 +3,20 @@
This example combines Qt6 GUI (C++) with WGPU rendering (Rust). It doesn’t do much of either but it’s the bridging what’s relevant. This example combines Qt6 GUI (C++) with WGPU rendering (Rust). It doesn’t do much of either but it’s the bridging what’s relevant.
Currently only X11 (XCB) is supported but it should be easy to extend to other platforms. Currently only X11 (XCB) is supported but it should be easy to extend to other platforms.
## Usage
This program is intended as a starting point rather than a dependency, so just copy it.
1. Fetch this code:
* clone the repo: `git clone https://gitea.noteuclid.ru/noteuclid/qt-wgpu-skel.git`
* or, download and unpack the [tarball](https://gitea.noteuclid.ru/noteuclid/qt-wgpu-skel/archive/master.tar.gz).
2. Rename the directory to your liking
3. Change the name in all files:
* `PROJECT NAME` to the user-visible project name,
* `PROJECT-NAME` to the technical project name (ASCII, no spaces),
* `PROJECT_NAME` to the same with dashes (`-`) replaced with underscores (`_`),
* `PROJECTNAME` to the same in PascalCase.
If you want to use Qt5, change the version in both `CMakeLists.txt`, as well as the KF version.
If you don’t want to depend on KDE, remove the ECM and KF5 dependencies, as well as `KColorCombo inBackground` from the UI. You’ll need to replace `inBackground->color()` with something else though.