From 24f3bc5d710bec393e792cbb11b921cb29b22ea6 Mon Sep 17 00:00:00 2001
From: numzero <numzer0@yandex.ru>
Date: Fri, 3 Apr 2026 14:57:51 +0300
Subject: [PATCH] add usage notes

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/README.md b/README.md
index a179901..4c819e4 100644
--- a/README.md
+++ b/README.md
@@ -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.
 
 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.