craftbeerpi4-pione/README.md

# CraftBeerPi 4

[![Build](https://github.com/avollkopf/craftbeerpi4/actions/workflows/build.yml/badge.svg)](https://github.com/avollkopf/craftbeerpi4/actions/workflows/build.yml)
[![GitHub license](https://img.shields.io/github/license/avollkopf/craftbeerpi4)](https://github.com/avollkopf/craftbeerpi4/blob/master/LICENSE)
![GitHub issues](https://img.shields.io/github/issues-raw/avollkopf/craftbeerpi4)
![PyPI](https://img.shields.io/pypi/v/cbpi4)
![Happy Brewing](https://img.shields.io/badge/CraftBeerPi%204-Happy%20Brewing-%23FBB117)

<p align="center">
  <img src="https://github.com/avollkopf/craftbeerpi4-ui/blob/main/cbpi4gui/public/logo192.png?raw=true" alt="CraftBeerPi Logo"/>
</p>

CraftBeerPi 4 is an open source software solution to control the brewing and
fermentation of beer :beer:.

## 📚 Documentation
Instructions on how to install CraftBeerPi and use its plugins is described
in the documentation, that can be found here: [gitbook.io](https://openbrewing.gitbook.io/craftbeerpi4_support/).

### Plugins
Plugins extend the base functionality of CraftBeerPi 4.
You can find a list of available plugins [here](https://openbrewing.gitbook.io/craftbeerpi4_support/master/plugin-installation#plugin-list).

## 🧑‍🤝‍🧑 Contribute
You want to help develop CraftBeerPi4? To get you quickly stated, this repository comes with a preconfigured
development environment. To be able to use this environment you need 2 things installed on your computer:

- docker
- visual studio code (vscode)

To start developing clone this repository, open the folder in vscode and use the _development container_ feature. The command is called _Reopen in container_. Please note that this quick start setup does not work if you want to develop directly on a 32bit raspberry pi os because docker is only available for 64bit arm plattform. Please use the regular development setup for that.

For a more detailed description of a development setup without the _development container_ feature see the documentation page:
[gitbook.io](https://openbrewing.gitbook.io/craftbeerpi4_support/)

### Contributors
Thanks to all the people who have contributed

[![contributors](https://contributors-img.web.app/image?repo=avollkopf/craftbeerpi4)](https://github.com/avollkopf/craftbeerpi4/graphs/contributors)
Update readme to include more info about the project 2021-11-29 00:10:28 +01:00			`# CraftBeerPi 4`
config added 2018-11-16 21:46:57 +01:00
some updated links 2022-05-10 17:52:23 +02:00			`[![Build](https://github.com/avollkopf/craftbeerpi4/actions/workflows/build.yml/badge.svg)](https://github.com/avollkopf/craftbeerpi4/actions/workflows/build.yml)`
			`[![GitHub license](https://img.shields.io/github/license/avollkopf/craftbeerpi4)](https://github.com/avollkopf/craftbeerpi4/blob/master/LICENSE)`
			`![GitHub issues](https://img.shields.io/github/issues-raw/avollkopf/craftbeerpi4)`
			`![PyPI](https://img.shields.io/pypi/v/cbpi4)`
Update readme to include more info about the project 2021-11-29 00:10:28 +01:00			`![Happy Brewing](https://img.shields.io/badge/CraftBeerPi%204-Happy%20Brewing-%23FBB117)`
config added 2018-11-16 21:46:57 +01:00
Update readme to include more info about the project 2021-11-29 00:10:28 +01:00			`<p align="center">`
Update README.md 2022-05-11 07:38:35 +02:00			`<img src="https://github.com/avollkopf/craftbeerpi4-ui/blob/main/cbpi4gui/public/logo192.png?raw=true" alt="CraftBeerPi Logo"/>`
Update readme to include more info about the project 2021-11-29 00:10:28 +01:00			`</p>`

			`CraftBeerPi 4 is an open source software solution to control the brewing and`
			`fermentation of beer :beer:.`

			`## 📚 Documentation`
			`Instructions on how to install CraftBeerPi and use its plugins is described`
			`in the documentation, that can be found here: [gitbook.io](https://openbrewing.gitbook.io/craftbeerpi4_support/).`

			`### Plugins`
			`Plugins extend the base functionality of CraftBeerPi 4.`
			`You can find a list of available plugins [here](https://openbrewing.gitbook.io/craftbeerpi4_support/master/plugin-installation#plugin-list).`

Configure devcontainer for python 2022-02-16 12:51:09 +01:00			`## 🧑‍🤝‍🧑 Contribute`
			`You want to help develop CraftBeerPi4? To get you quickly stated, this repository comes with a preconfigured`
			`development environment. To be able to use this environment you need 2 things installed on your computer:`

			`- docker`
			`- visual studio code (vscode)`

			`To start developing clone this repository, open the folder in vscode and use the _development container_ feature. The command is called _Reopen in container_. Please note that this quick start setup does not work if you want to develop directly on a 32bit raspberry pi os because docker is only available for 64bit arm plattform. Please use the regular development setup for that.`

			`For a more detailed description of a development setup without the _development container_ feature see the documentation page:`
			`[gitbook.io](https://openbrewing.gitbook.io/craftbeerpi4_support/)`

			`### Contributors`
Update readme to include more info about the project 2021-11-29 00:10:28 +01:00			`Thanks to all the people who have contributed`

some updated links 2022-05-10 17:52:23 +02:00			`[![contributors](https://contributors-img.web.app/image?repo=avollkopf/craftbeerpi4)](https://github.com/avollkopf/craftbeerpi4/graphs/contributors)`