From 0729fed5c2a75ec0dce3ea9ab920385d841b1248 Mon Sep 17 00:00:00 2001
From: Janis Hutz <development@janishutz.com>
Date: Mon, 12 May 2025 16:27:48 +0200
Subject: [PATCH] Improve README, add requirements.txt

---
 README.md        | 60 ++++++++++++++++++++++--------------------------
 requirements.txt |  2 ++
 2 files changed, 30 insertions(+), 32 deletions(-)
 create mode 100644 requirements.txt

diff --git a/README.md b/README.md
index a20b32e..558f052 100644
--- a/README.md
+++ b/README.md
@@ -4,22 +4,22 @@
 </div>
 
 <div id="badges" align="center">
-    <img src="https://img.shields.io/github/license/simplePCBuilding/BiogasControllerApp.svg">
-    <img src="https://img.shields.io/github/repo-size/simplePCBuilding/BiogasControllerApp.svg">
-    <img src="https://img.shields.io/tokei/lines/github/simplePCBuilding/BiogasControllerApp">
-    <img src="https://img.shields.io/github/languages/top/simplePCBuilding/BiogasControllerApp">
-    <img src="https://img.shields.io/github/directory-file-count/simplePCBuilding/BiogasControllerApp.svg">
+    <img src="https://img.shields.io/github/license/janishutz/BiogasControllerApp.svg">
+    <img src="https://img.shields.io/github/repo-size/janishutz/BiogasControllerApp.svg">
+    <img src="https://img.shields.io/tokei/lines/github/janishutz/BiogasControllerApp">
+    <img src="https://img.shields.io/github/languages/top/janishutz/BiogasControllerApp">
+    <img src="https://img.shields.io/github/directory-file-count/janishutz/BiogasControllerApp.svg">
     <br>
-    <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/simplePCBuilding/BiogasControllerApp">
-    <img alt="GitHub watchers" src="https://img.shields.io/github/watchers/simplePCBuilding/BiogasControllerApp">
-    <img src="https://img.shields.io/github/issues-pr-raw/simplePCBuilding/BiogasControllerApp">
-    <img alt="GitHub forks" src="https://img.shields.io/github/forks/simplePCBuilding/BiogasControllerApp">
-    <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/simplePCBuilding/BiogasControllerApp">
+    <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/janishutz/BiogasControllerApp">
+    <img alt="GitHub watchers" src="https://img.shields.io/github/watchers/janishutz/BiogasControllerApp">
+    <img src="https://img.shields.io/github/issues-pr-raw/janishutz/BiogasControllerApp">
+    <img alt="GitHub forks" src="https://img.shields.io/github/forks/janishutz/BiogasControllerApp">
+    <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/janishutz/BiogasControllerApp">
     <br>
-    <img alt="GitHub all releases" src="https://img.shields.io/github/downloads/simplePCBuilding/BiogasControllerApp/total?label=Downloads (total)">
-    <img alt="GitHub release (latest by date)" src="https://img.shields.io/github/downloads/simplePCBuilding/BiogasControllerApp/latest/total?label=Downloads (latest)">
-    <img src="https://img.shields.io/github/release/simplePCBuilding/BiogasControllerApp.svg">
-    <img src="https://img.shields.io/github/package-json/v/simplePCBuilding/BiogasControllerApp.svg?label=Development Version">
+    <img alt="GitHub all releases" src="https://img.shields.io/github/downloads/janishutz/BiogasControllerApp/total?label=Downloads (total)">
+    <img alt="GitHub release (latest by date)" src="https://img.shields.io/github/downloads/janishutz/BiogasControllerApp/latest/total?label=Downloads (latest)">
+    <img src="https://img.shields.io/github/release/janishutz/BiogasControllerApp.svg">
+    <img src="https://img.shields.io/github/package-json/v/janishutz/BiogasControllerApp.svg?label=Development Version">
 </div>
 
 <div id="donate" align="center">
@@ -31,41 +31,37 @@ BiogasControllerApp has just received a major rewrite, where I focused on code-r
 If you are here to read the code, the files you are most likely looking for can be found in the `biogascontrollerapp/lib` folder. If you want to understand and have a look at all of the application, start with the `biogascontrollerapp.py` file in the `biogascontrollerapp` folder
 
 # Features
-
-***LOOKING FOR A MacOS BUILD MAINTAINER! You may follow the official build instructions on the kivy.org website. All other materials should already be included in this repository***
-		
-## FEATURES
-- Easily read out the data the Microcontroller used in ENATECH sends
-- Easily change the coefficients for the temperature sonds
-- Easily change the temperature that is set for the controller to heat to
-- Easy to navigate menus and submenus for better organisation
-- (Almost) Bugfree
-- Detailed and still private logging (not sending any information to anybody except you do)
+- Read data the microcontroller in ENATECH sends
+- Configure the microcontroller (Coefficients & Temperature). Old settings will be pre-loaded
+- Focus on code quality and readability as well as stability
+- Tips to resolve errors directly in the app
 - The app is still maintained and as such known issues will be resolved
-- Highly detailed error resolving instructions directly inside the app 
-- Easy to run: No extra Software required (e.g. Python or similar) (currently Windows only)
-- Easy to install and uninstall as it has an installer and uninstaller
-- Some settings are available through the /config/settings.ini file
-	
+- Installer for Windows, deb, rpm and arch package available
+- Clean UI focusing on ease of use
+- Documented code so you can more easily understand what is happening
+
+
 # Issues
 If you encounter any bugs or other weird behaviour, please open an issue on this GitHub repository. 
 
 # Documentation
-You may find documentation for this project in its wiki here on GitHub.
+You may find documentation for this project in its wiki here on GitHub. The code is also documented with explanations what it does
 
 # Officially Supported OS
 - Microsoft Windows 10, 11 (through my installer, may though support older Versions but this is not verified. Open an issue if you have managed to run it on an older version of Windows)
 - Microsoft Windows XP, Vista, 7, 8, 10, 11 (through running the package with Python yourself)
 - MacOS 10.9 (Mavericks) or later (required by Python)
 - GNU/Linux: All distros that support Python 3.8 or later
-- FreeBSD: Works with slight modification of the source code 
+- FreeBSD: If you have Pyhton 3.8 or later installed 
 
 ## Dependencies
 Only needed if you run with python directly
-- Python 3.8 - 3.10 (only tested on these versions)
+- Python 3.10 - 3.12 (only tested on this version, but should work down to at least 3.8 and with the latest versions)
 - kivy
 - pyserial
 
+To install them, run `pip install -r requirements.txt`
+
 # Contributing
 If you wish to contribute to this project, please fork this repository, create a new branch in your fork, make your changes and open a pull request in this repo. 
 
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..e87f278
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,2 @@
+kivy[base]
+pyserial