From 764e5159d041cab25675495798a1660cad25e87d Mon Sep 17 00:00:00 2001
From: Oleg Kalachev <okalachev@gmail.com>
Date: Tue, 22 Jul 2025 13:51:21 +0300
Subject: [PATCH] Add correct note on usage alongside QGroundControl

---
 tools/pyflix/README.md | 20 ++++++++++++++++++++
 tools/pyproject.toml   |  2 +-
 2 files changed, 21 insertions(+), 1 deletion(-)

diff --git a/tools/pyflix/README.md b/tools/pyflix/README.md
index 2d73506..69e2de1 100644
--- a/tools/pyflix/README.md
+++ b/tools/pyflix/README.md
@@ -132,6 +132,26 @@ The flight control feature is in development. List of methods intended for autom
 * `set_controls`
 * `set_mode`
 
+## Usage alongside QGroundControl
+
+You can use the Flix library alongside the QGroundControl app, using a proxy mode. To do that:
+
+1. Run proxy for `pyflix` and QGroundControl in background:
+
+   ```bash
+   flix-proxy
+   ```
+
+2. Go to QGroundControl settings ⇒ *Comm Links*.
+3. Add new link with the following settings:
+   * *Name*: Proxy
+   * *Automatically Connect on Start*: ✓
+   * *Type*: UDP
+   * *Port*: 14560
+4. Restart QGroundControl.
+
+Now you can run `pyflix` scripts and QGroundControl simultaneously.
+
 ## Tools
 
 The following scripts demonstrate how to use the library:
diff --git a/tools/pyproject.toml b/tools/pyproject.toml
index 3bb205d..276c65f 100644
--- a/tools/pyproject.toml
+++ b/tools/pyproject.toml
@@ -11,7 +11,7 @@ dependencies = [
 ]
 
 [project.scripts]
-flixproxy = "pyflix.proxy:main"
+flix-proxy = "pyflix.proxy:main"
 
 [build-system]
 requires = ["setuptools>=61.0"]