diff --git a/README.md b/README.md new file mode 100644 index 0000000..ebb7e2a --- /dev/null +++ b/README.md @@ -0,0 +1,117 @@ + + + ---------------------------------------------------------- + + BiogasControllerApp V2.1 + + ---------------------------------------------------------- + + + Thank you for downloading the new Version of the BiogsaControllerApp! You are greeted with + lots of new features, including a new and redesigned Graphical User Interface (later "GUI") + and an automatic assignment of the comport on Windows. + + ---------------------------------------------------------------------------- + +*FEATURE LIST* + - 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 + - Highly detailed error resolving instructions directly inside of the app + - Easy to run: No extra Software required (e.g. Python or similar) + - Easy to install and uninstall as it has an installer and uninstaller + + +####################################################################################################### + + _________ + + CHANGELOG + _________ + + DEVELOPMENT VERSIONS + ....................... + + dev-V2rev1: + - new GUI + - complete rework of the backend + - functioning value reading module + + dev-V2rev2: + - functioning Read-Data Screen + - automatic assignment of the serial port + + dev-V2rev3: + - functioning Change-Temperature screen + - functioning Change-All-Data screen + + dev-V2rev4: + - some Error-Infos were added + + V2-Rc1: + - Bugfixes + + V2-Rc2: + - Bugfixes + + + dev-V2.1rev1: + - fixed a bug, where it was possible that the app crashed if an error in + the communication module occured + + dev-V2.1rev2: + - Optimised port assignment so that it now can handle multiple comports + + dev-V2.1rev3: + - added way more detailed Error information and Error-resolving hints + + dev-v2.1rev4: + - fixed a bug, where it was possible that the app crashed if one unplugged + the cable whilst in any other screen than the homescreen or credits screen + + V2.1-Rc1: + - small Bugfixes + + + + FULL RELEASES + ...................... + + V2: + - NEW GUI + - NEW Backend + - AUTOMATIC assignment of COMPORTS + + V2.1 + - DETAILED Error-Info + - DETAILED Error-Resolving-Tips + - MORE RELIABLE Comport handling + - BUGFIXES + + + +****************************************************************************************************** + + THIS APP IS FREE TO USE FOR ALL STUDENTS AT THE + KANTONSSCHULE WOHLEN + +****************************************************************************************************** + + + DEVELOPMENT: + + - Microcontroller Software: Dr. A. Cornaz + - BiogasControllerApp V1.0.0: S. Reichmuth + - BiogasControllerApp V2.x: J. Hutz + + + +================================== +=== COPYRIGHT 2022 J. Hutz ====== +================================== + + + +