diff --git a/README.md b/README.md index 61636d0..a3eb44a 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,34 @@ -# Goal +# Project Name -## Milestone 1 +## Milestones + +### Milestone 1 The Goal is to display and visualize data received/measured from a Raspberry Pi on a webinterface. -## Milestone 2 +### Milestone 2 The Raspberry Pi should be integratable to a Home Assistant Server and be used as as sensor input and opitionally logic level output. -## Milestone 3 +### Milestone 3 Data should be sent and received via MQTT to an ESP32. The Pi acts as a sensor gateway. -# Ausführung +## Tech Stack -- **Programmiersprache**: Python -- **Libraries**: -- **Sensoren**: +- **Raspberry Pi model**: +- **Programming languages**: Python +- **Frameworks/tools/Libraries**: (e.g., Flask, GPIO Zero) + +## Hardware Requirements + +- Raspberry Pi with [model/specs] +- **Sensors**: - LER (Lichtsensor) - Temperatur und Luftfeuchtigkeit - ... -# Docs +## Docs - `requirements.txt` This file holds the requirements for pip @@ -30,22 +37,34 @@ Data should be sent and received via MQTT to an ESP32. The Pi acts as a sensor g - `main.py` The main file for the project -# Arbeitsaufträge / Aufgabeneinteilung +### Git Help -## Zu Vergeben +![A Git Cheatsheet](gitHelp.png "Git Cheatsheet") + +### MarkDown Help + +![A MarkDown Cheatsheet](mdHelp.png "MarkDown Cheatsheet") + +## Arbeitsaufträge / Aufgabeneinteilung + +### Zu Vergeben - Präsentation - Programme: - Daten von RPI erfassen und sauber abspeichern - Daten an einem Webserver anzeigen -| Kieler | Chiara | -| -------------- | ------ | -| Everything Git | | -| | | -| | | +| Kieler | Chiara | +| ------ | ------ | +| Git | | +| Readme | | +| | | -# Credits +### Acknowledgments [Chiara](https://git.miaig.dev/chiara) [Kieler](https://git.miaig.dev/mia) + +### License + +MIT diff --git a/gitHelp.png b/gitHelp.png new file mode 100644 index 0000000..50dc28d Binary files /dev/null and b/gitHelp.png differ diff --git a/mdHelp.png b/mdHelp.png new file mode 100644 index 0000000..82c5637 Binary files /dev/null and b/mdHelp.png differ