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

Updated Install and run the program (markdown)

Janis Hutz
2023-07-26 18:39:06 +00:00
parent b20052ae3d
commit a728b88060
1 changed files with 17 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
Install-and-run-the-program.md

@@ -28,56 +28,32 @@
5. Now type in `python3 biogascontrollerapp.py`. Same here, without the quotation marks
# DOWNLOAD dev versions (if you run into a bug, then this may help)
The process is similar on every operating system, though the installation process for git is different as well as the one for python. You may also download the file as zip from the main page and skip the installation process for git and the git cloning steps.
## Installing GIT
### GNU/Linux
1. open a bash terminal
First things first, you need to get the code of the BiogasControllerApp. For this, head to the "code" tab on GitHub and then, when downloading the development version, click "code" (the green button) and hit "download zip". If you want to download the code for the latest release of the BiogasControllerApp, then instead of clicking onto the green "code" button, click onto "Releases" on the right-hand side and select the latest release. Then, download either the Zip file or the G-Zip compressed Tarball (.tar.gz file).
#### Debian / Ubuntu based distros
2. type `sudo apt-get install git`
Now head to the folder you downloaded the file into and extract the archive.
#### Arch based distros
2. type `sudo pacman install git`
#### Fedora based distros
2. type `sudo dnf -y install git`
### MacOS
1. open a terminal and type: `sudo port install git`
### Windows
1. head to this link, download and install the package: https://git-scm.com/download/win
## Installing Python + required packages:
### GNU/Linux (most distros)
1. Python is preinstalled, though you‘ll need to install pip on most distros. Use `sudo (your package manager name here, (apt-get for ubuntu / debian based distros; dnf for fedora and pacman for arch based)) install pip`
2. copy & paste the following commands into your terminal:
`pip install pyserial`
`pip install kivy[base]`
1. Python is preinstalled, though you‘ll need to install pip on most distros. Use `sudo (your package manager name here, (apt-get install for ubuntu / debian based distros; dnf install for fedora and pacman for arch based)) pip`
2. copy & paste the following command into your terminal:
`pip install pyserial kivy[base]`
*NOTE: Some distros have blocked pip and require you to use either pipx or the distro package manager. Read more in your distro's docs / wiki.*
### MacOS
1. head to this link, install python and make sure you have pip selected: https://www.python.org/downloads/macos/ (be sure to download python 3.8, as newer versions may come in conflict with kivy.
2. now open a terminal and type the following commands:
`pip install pyserial`
`pip install kivy[base]`
1. head to this link, install python and make sure you have pip selected: https://www.python.org/downloads/macos/
2. now open a terminal and type the following command:
`pip install pyserial kivy[base]`
### Windows
1. head to this link, install python and make sure you have pip selected: https://www.python.org/downloads/windows/ (be sure to download python 3.8 as newer versions may come in conflict with kivy.
2. now open the command prompt (by typing „cmd“ into the search bar for example
3. type the following commands:
`pip install pyserial`
`pip install kivy[base]`
1. head to this link, install python and make sure you have pip selected: https://www.python.org/downloads/windows/
2. now open the command prompt (by typing “cmd” into the search bar, for example)
3. type the following command:
`pip install pyserial kivy[base]`
## Cloning the repository
Now that you have all of the dependencies installed on your system you may now clone the git repository. This works pretty much the same on every operating system.
1. Go ahead and open the terminal (GNU/Linux and MacOS) or the Command Prompt (Windows) and type the following
`git clone https://github.com/simplePCBuilding/BiogasControllerApp.git`
2. This will clone the repository into your home folder (GNU/Linux), Users folder (MacOS and Windows)
## Launching the app
1. On MacOS and Linux use the following command to head into the folder you just cloned the repository into:
`cd ./BiogasControllerApp`, press tab, then type `BiogasControllerApp` and press tab again. Finally, press enter.
On Windows open your Explorer, navigate into the users folder (it is located on your C drive), then into the BiogasControllerApp-main-Folder, then into BiogasControllerApp-V2.x (whereas x is to be replaced with whatever folder‘s in there with that structure). Then click on the bar where you can find the path. Type in „cmd“.
1. On MacOS and Linux, open a terminal in the project folder.
`cd ./BiogasController`, press tab and then press enter.
On Windows open your Explorer and navigate into the BiogasControllerApp-VX.X (whereas x is to be replaced with whatever folder‘s in there with that structure). Then click on the bar where you can find the path. Type in „cmd“.
2. You may start the app by typing `python3 biogascontrollerapp.py`