Adding a UI Rule Configurator

build_portable.py

@@ -35,19 +35,20 @@
 
 # Running PyInstaller to build the application
 PyInstaller.__main__.run([
-    'process-governor.py',                      # Source script file
-    '--clean',                                  # Clean previous builds
-    '--noconfirm',                              # No confirmation when deleting dist directory
-    '--onedir',                                 # Build the app in one directory
-    '--uac-admin',                              # Request admin rights on launch
-    '--hide-console', 'hide-early',             # Hide the console on startup
+    'process-governor.py',  # Source script file
+    '--clean',  # Clean previous builds
+    '--noconfirm',  # No confirmation when deleting dist directory
+    '--onedir',  # Build the app in one directory
+    '--uac-admin',  # Request admin rights on launch
+    '--hide-console', 'hide-early',  # Hide the console on startup
     '--add-data', './resources/*;./resources',  # Add additional resources
-    '--contents-directory', 'scripts',          # Directory for Python and app scripts in the built package
-    '--icon', 'resources/app.ico',              # Application icon
-    '--debug', 'noarchive',                     # Disables bundling of application scripts inside the exe
-    '--name', APP_NAME,                         # Name of the executable file
-    '--version-file', VERSION_FILE,             # Path to the version file
-    '--distpath', DIST,                         # Directory to save the built application
+    '--contents-directory', 'scripts',  # Directory for Python and app scripts in the built package
+    '--icon', 'resources/app.ico',  # Application icon
+    '--debug', 'noarchive',  # Disables bundling of application scripts inside the exe
+    '--name', APP_NAME,  # Name of the executable file
+    '--version-file', VERSION_FILE,  # Path to the version file
+    '--distpath', DIST,  # Directory to save the built application
+    '--collect-all', 'tksvg',
 ])
 
 # Creating an archive of the built application

docs/README.md

@@ -0,0 +1,52 @@
+![Logo Process Governor](images/github-banner-readme.png)
+
+[![RU](icons/ru.png) Русская версия](README.ru.md)
+
+---
+
+**Process Governor** is a Python utility designed to manage Windows processes and services by adjusting their
+priorities, I/O priorities, and core affinity based on user-defined rules.
+
+<details>
+   <summary>Screenshots</summary>
+
+   >![tray_menu_screenshot.png](images/tray_menu_screenshot.png)
+   > 
+   >![audio_artiacle_rule_configurator_screenshot.png](images/audio_artiacle_rule_configurator_screenshot.png)
+   > 
+   >![rule_configurator_with_error_screenshot.png](images/rule_configurator_with_error_screenshot.png)
+</details>
+
+## Features
+
+- Adjust process and service priorities for better performance.
+- Control I/O priorities to optimize resource utilization.
+- Define core affinity for processes.
+- Fine-tune Windows services and processes based on [user-defined rules](ui_rule_configurator.md).
+- Continuous monitoring of the configuration file for rule application.
+- Ability to add ProcessGovernor to autorun.
+
+## Getting started
+
+To get started with **Process Governor**, follow these steps:
+
+1. Download the latest ready-to-use build from the following
+   link: [Latest Release](https://github.com/SystemXFiles/process-governor/releases/latest).
+2. Run the `Process Governor.exe` executable with **administrative privileges**.
+   This is important to allow the program to make the necessary adjustments to process and service priorities, I/O
+   priorities, and core affinity.
+3. [Configure the rules](ui_rule_configurator.md) for processes and services.
+
+You can close the program by accessing the tray icon.
+
+## Knowledge base
+
+- [Configuring rules](ui_rule_configurator.md)
+- [Configuration file](configuration_file.md)
+- [Running from source and creating a portable build](run_and_build.md)
+- **Tips and Tricks**
+  - [Optimizing Audio](tips'n'tricks/audio.md)
+  - [Optimizing Games](tips'n'tricks/game_optimization.md)
+## License
+
+This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](../LICENSE) file for details.