From 8aa11a20837ea6b96921fc70e5f1982de3d4f65a Mon Sep 17 00:00:00 2001
From: Marcin Szczyglinski <szczyglis@protonmail.com>
Date: Sun, 25 Aug 2024 17:27:17 +0200
Subject: [PATCH] Added description to bash scripts

---
 build.bat    | 1 +
 build.sh     | 2 +-
 clean.sh     | 1 +
 install.bat  | 1 +
 install.sh   | 2 +-
 run-tests.sh | 2 +-
 run.bat      | 1 +
 run.sh       | 2 +-
 shortcut.bat | 1 +
 shortcut.sh  | 2 +-
 snaprun.sh   | 1 +
 11 files changed, 11 insertions(+), 5 deletions(-)

diff --git a/build.bat b/build.bat
index 2bfc95a88..d96e52ae9 100755
--- a/build.bat
+++ b/build.bat
@@ -1,2 +1,3 @@
+:: This script is used to build the app using pyinstaller
 call venv\Scripts\activate
 call pyinstaller windows.spec
\ No newline at end of file
diff --git a/build.sh b/build.sh
index 1fdf3cade..4e3d72ae2 100755
--- a/build.sh
+++ b/build.sh
@@ -1,5 +1,5 @@
 #!/bin/bash
-
+# This script is used to build the app using pyinstaller
 source ./venv/bin/activate
 python -m build
 twine check dist/*
diff --git a/clean.sh b/clean.sh
index f177b7e7c..0bf810d50 100755
--- a/clean.sh
+++ b/clean.sh
@@ -1,4 +1,5 @@
 #!/bin/bash
+# This script is used to recursive remove the __pycache__ directories
 TARGET_DIR="./src" # clear '__pycache__'
 
 find "$TARGET_DIR" -type d -name "__pycache__" | while read -r dir
diff --git a/install.bat b/install.bat
index 221ab8ba0..aa931f91b 100755
--- a/install.bat
+++ b/install.bat
@@ -1,3 +1,4 @@
+:: This script is used to install the app dependencies and run the app using the virtual environment
 call python -m venv venv
 call venv\Scripts\activate
 call pip install -r requirements.txt
diff --git a/install.sh b/install.sh
index 07a6c16fd..9d8a73d6f 100644
--- a/install.sh
+++ b/install.sh
@@ -1,5 +1,5 @@
 #!/bin/bash
-
+# This script is used to install the app dependencies and run the app using the virtual environment
 python -m venv ./venv
 pip install -r requirements.txt
 python3 run.py "$@"
\ No newline at end of file
diff --git a/run-tests.sh b/run-tests.sh
index 3b2343e0a..0ef3c784a 100755
--- a/run-tests.sh
+++ b/run-tests.sh
@@ -1,4 +1,4 @@
 #!/bin/bash
-
+# This script is used to run the tests using the virtual environment
 source ./venv/bin/activate
 pytest -vv
\ No newline at end of file
diff --git a/run.bat b/run.bat
index 93b6a6c66..f1d3e2152 100755
--- a/run.bat
+++ b/run.bat
@@ -1,2 +1,3 @@
+:: This script is used to run the app using the virtual environment
 call venv\Scripts\activate
 call python run.py %*
\ No newline at end of file
diff --git a/run.sh b/run.sh
index 812f81c8a..b268d46a3 100755
--- a/run.sh
+++ b/run.sh
@@ -1,4 +1,4 @@
 #!/bin/bash
-
+# This script is used to run the app using the virtual environment
 source ./venv/bin/activate
 python3 run.py "$@"
\ No newline at end of file
diff --git a/shortcut.bat b/shortcut.bat
index 750987892..8c0c399b8 100644
--- a/shortcut.bat
+++ b/shortcut.bat
@@ -1,3 +1,4 @@
+:: This script is used to run the app using the virtual environment
 @echo off
 cd /d "%~dp0" 
 call venv\Scripts\activate
diff --git a/shortcut.sh b/shortcut.sh
index 6eacc7d10..c99029bac 100755
--- a/shortcut.sh
+++ b/shortcut.sh
@@ -1,5 +1,5 @@
 #!/bin/bash
-
+# This script is used to run the app using the virtual environment
 cd "$(dirname "$0")"
 source ./venv/bin/activate
 python3 run.py "$@"
\ No newline at end of file
diff --git a/snaprun.sh b/snaprun.sh
index 786464c88..6369e600d 100755
--- a/snaprun.sh
+++ b/snaprun.sh
@@ -1,5 +1,6 @@
 #!/bin/bash
 
+# This script is used to run the app in the snap environment
 # export QTWEBENGINE_DISABLE_GPU=1
 # export QTWEBENGINE_CHROMIUM_FLAGS="--enable-logging --log-level=0 --v=1"