From 0ed362613af9d4ad69a155cc1afd6d353edd5143 Mon Sep 17 00:00:00 2001
From: miruka <miruka@disroot.org>
Date: Fri, 5 Jun 2020 11:07:10 -0400
Subject: [PATCH] Better comment live-reload.sh

---
 live-reload.sh | 17 +++++++++++------
 1 file changed, 11 insertions(+), 6 deletions(-)

diff --git a/live-reload.sh b/live-reload.sh
index 597cbaa6..c6be9120 100755
--- a/live-reload.sh
+++ b/live-reload.sh
@@ -1,13 +1,18 @@
 #!/usr/bin/env sh
 
-# pdb won't be usable with entr,
-# use https://pypi.org/project/remote-pdb/ instead.
-
-# An argument can be given to specify which QML file in src/gui to load.
+# Dependencies: findutils, entr
+#
+# This script will watch for source file changes and recompile-restart Mirage
+# when needed. If it gets stuck restarting in loop, press CTRL-C a bunch of
+# times and try again.
+#
+# pdb won't be usable due to entr, use https://pypi.org/project/remote-pdb/
+# instead (should be present if you install requirements-dev.txt).
+#
+# An argument can be given to specify which QML file in src/gui to load,
+# for example "Test.qml" would load "src/gui/Test.qml".
 # If no argument is given, the default is "UI.qml".
 
-export QT_QPA_PLATFORM=xcb
-
 make clean
 qmake mirage.pro CONFIG+=dev && make