From ae2f7b46474c1fc3431ca537df6416da1f54e881 Mon Sep 17 00:00:00 2001 From: janis Date: Thu, 23 Jun 2022 14:02:58 +0200 Subject: [PATCH] Update changelog, README.md, SECURITY.md --- README.md | 21 ++++++++++----------- SECURITY.md | 1 + changelog | 28 +++++++++++++++++++++++++++- 3 files changed, 38 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index d973277..844902b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -**BiogasControllerApp V2.3** +**BiogasControllerApp V2.3.0** THIS SOFWARE FALLS UNDER THE GPL V3 LICENSE AND AS SUCH COMES WITH ABSOLUTELY NO WARRANTY! @@ -17,28 +17,27 @@ and an automatic assignment of the comport on all supported Operating systems (s - 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) - The app is still maintained and as such known issues will be resolved -- Highly detailed error resolving instructions directly inside of the app -- Easy to run: No extra Software required (e.g. Python or similar) +- 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 *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 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: Works with slight modification of the source code - -***THIS APP IS FREE TO USE FOR EVERYONE THAT HAS USE FOR IT*** - -*Please also read the license agreement (this project falls under the GPLv3 License and as such -you are obligated to reuse the same license if you intend to fork this project!* - +*Required packages/programs to install the app yourself* +- Python 3.8 - 3.10 (only tested on these versions) +- kivy +- pyserial DEVELOPMENT: diff --git a/SECURITY.md b/SECURITY.md index c0dfc85..8bc71f8 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -16,3 +16,4 @@ The support for Version 2.2.0 and below will end with the next Version (2.4.0)! ## Reporting a Vulnerability If you find any potential security issues, please let me know through the issues tab. You can expect an update to arrive in not under a week of opening the issue. +Other option: Fix it yourself and then open a pull request on this GitHub page. diff --git a/changelog b/changelog index c8a0592..4c9d366 100644 --- a/changelog +++ b/changelog @@ -59,6 +59,25 @@ dev-V2.2rev5: V2.2-Rc1: - fixed a bug that could cause the app not to show any error when using the new feature. + +dev-V2.3rev1 +- Added a config file with config readout + +dev-V2.3rev2 +- Added a logger so bugs can more easily be found + +dev-V2.3rev3 +- Fixed a bug that sometimes crashed the app and in the other cases didn't properly load the old values + +dev-V2.3rev4 +- A couple of bugfixes + +dev-V2.3rev5 +- Added the GPL V3 License +- Added License information into the program as this is required by the License + +V2.3-Rc1: +- Bugfixes FULL RELEASES @@ -73,8 +92,15 @@ V2.1 - MORE RELIABLE Comport handling - BUGFIXES -V2.2 (Upcoming) +V2.2 - ALLOWS for easier configuration changing - ADDS a Settings screen - ADDS easier bug-reporting - BUGFIXES + +V2.3 +- UPDATES / FIXES support for partial reprogramming (old values will be loaded) +- ADDS logging (you can include the logs in a bugreport so the devs can pin-point the exact cause and replicate the error) +- ADDS some settings through a config file +- CHANGED License from NONE to GPL V3 +- BUGFIXES \ No newline at end of file