diff --git a/.gitbook/assets/bildschirmaufnahme-2021-01-24-um-11.47.30.mov b/.gitbook/assets/bildschirmaufnahme-2021-01-24-um-11.47.30.mov new file mode 100644 index 0000000..40d991a Binary files /dev/null and b/.gitbook/assets/bildschirmaufnahme-2021-01-24-um-11.47.30.mov differ diff --git a/README.md b/README.md index 3caa449..759653f 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ CraftBeerPi is an open source brewing controller. +![](.gitbook/assets/bildschirmaufnahme-2021-01-24-um-11.47.30.mov) + ## Installation CraftBeerPi is python based and will require at last python 3.7.x @@ -13,23 +15,46 @@ Download an install Python 3.7 [https://www.python.org/downloads/](https://www. Open a terminal window and run the following commands. +#### Downloas the software via Python pip + ```text sudo python3 -m pip install cbpi ``` -```text +#### Setup Environment + +```bash cbpi setup ``` +The setup command will create a config folder in directory where you executed this command. The config folder contains all instance data. For example all your hardware configuration and log files. + +{% hint style="info" %} +You can setup as many enviroments as you like on one computer / Raspberry pi. +Just navigate to a diffent folder and run the setup command again. This will create additional config folder +{% endhint %} + +#### Run the Server + ```text cbpi start ``` The server is running under http://localhost:8000 by default. +#### Access the User Interface + +```text +http://:8000/ +``` + +{% hint style="info" %} +Port 8000 is the default port. You can change this port in the config folder config.yaml +{% endhint %} + ### Installation from GitHub -You can install the latest master version direclty from GitHub. +You can install the latest development version direclty from GitHub. ```text pip install https://github.com/Manuel83/craftbeerpi4/archive/master.zip @@ -48,6 +73,12 @@ python3 -m venv venv source venv/bin/activate ``` +## Uninstall + +```text +pip uninstall cbpi +``` + ## Links {% embed url="https://www.facebook.com/groups/craftbeerpi" %}