janishutz/BiogasControllerApp
1
0
Fork 0
mirror of https://github.com/janishutz/BiogasControllerApp.git synced 2025-11-25 05:44:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update changelog, README.md, SECURITY.md

Browse Source
This commit is contained in:
janis
2022-06-23 14:02:58 +02:00
parent b60ab5d1e8
commit ae2f7b4647
3 changed files with 38 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -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
***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:

1
SECURITY.md
View File

@@ -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.

28
changelog
View File

@@ -60,6 +60,25 @@ 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
V2:
@@ -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