craftbeerpi4-pione/README.md
2022-03-31 08:04:42 +02:00

2.3 KiB

CraftBeerPi 4

Build GitHub license GitHub issues PyPI Happy Brewing

CraftBeerPi Logo

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

📚 Documentation

Instructions on how to install CraftBeerPi and use its plugins is described in the documentation, that can be found here: gitbook.io.

Plugins

Plugins extend the base functionality of CraftBeerPi 4. You can find a list of available plugins here.

🧑‍🤝‍🧑 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

Contributors

Thanks to all the people who have contributed

contributors