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

Redo README

Browse Source 
I have to a major extent rewritten the readme files to reflect recent design changes I made to my README files
This commit is contained in:
Janis Hutz
2023-05-31 08:49:41 +02:00
committed by GitHub
parent e69c058345
commit 6afada30be
1 changed files with 37 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
README.md
View File

@@ -1,19 +1,31 @@
# **BiogasControllerApp V2.3.0**
THIS SOFWARE FALLS UNDER THE GPL V3 LICENSE AND AS SUCH COMES WITH
ABSOLUTELY NO WARRANTY!
***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***
<div id="title" align="center">
<img src="./logo.png" width="300">
<h1>BiogasControllerApp</h1>
</div>
Thank you for downloading the new Version of the BiogasControllerApp! 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 all supported Operating systems (see supported OS section).
## *FEATURE LIST*
<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">
<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">
<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">
</div>
***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
@@ -26,30 +38,24 @@ and an automatic assignment of the comport on all supported Operating systems (s
- Easy to install and uninstall as it has an installer and uninstaller
- Some settings are available through the /config/settings.ini file
# Issues
If you encounter any bugs or other weird behaviour, please open an issue on this GitHub repository.
*Officially Supported OS*
# Documentation
You may find documentation for this project in its wiki here on GitHub.
# 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
*Required packages/programs to install the app yourself*
## Dependencies
Only needed if you run with python directly
- Python 3.8 - 3.10 (only tested on these versions)
- kivy
- pyserial
DEVELOPMENT:
- BiogasControllerApp V2.x: simplePCBuilding
COPYRIGHT 2022 simplePCBuilding
# 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.