mirror of
https://github.com/PiBrewing/craftbeerpi4.git
synced 2024-09-16 20:57:29 +02:00
39 lines
2.3 KiB
Markdown
39 lines
2.3 KiB
Markdown
# CraftBeerPi 4
|
|
|
|
[](https://github.com/PiBrewing/craftbeerpi4/actions/workflows/build.yml)
|
|
[](https://github.com/PiBrewing/craftbeerpi4/blob/master/LICENSE)
|
|
|
|
|
|
|
|
|
|
<p align="center">
|
|
<img src="https://github.com/PiBrewing/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
|
|
|
|
[](https://github.com/PiBrewing/craftbeerpi4/graphs/contributors)
|