Browse Source

add setup instructions to README.md

FloKra 2 months ago
parent
commit
eb5e7a0816
1 changed files with 24 additions and 8 deletions
  1. 24 8
      README.md

+ 24 - 8
README.md

@@ -7,7 +7,7 @@ I developed this as I moved to Home Assistant, MQTT and Node-RED for all of my h
 
 
 
-Features:
+## Features
 
 - integrate 433MHz RF remote controls in MQTT based home automation systems like Home Assistant and Node-RED
 - control RF remote plugs and other devices such as ceiling fan controllers with MQTT messages while getting state updates whenever the original remote is used
@@ -22,16 +22,32 @@ Features:
 
 
 
-Installation:
+## Prerequisits
 
-(on Raspberry Pi as "pi" in folder /home/pi)
-
-git clone *URL*
-
-Prerequisits:
 - Python 3
-- Python 3 modules (install via pip3): 
+- Python 3 modules: 
   - pyyaml
   - pyserial
   - paho-mqtt
   
+
+## Installation
+
+(i.E. on Raspberry Pi as user "pi" in folder /home/pi)
+
+```
+git clone https://git.flokra.at/Flo/CUL2MQTT.git	
+
+apt install python3
+```
+
+#### On Debian 12 "Bookworm":
+```
+apt install python3-yaml python3-serial python3-paho-mqtt
+```
+
+#### On older Debian releases: 
+```
+apt install python3-pip
+pip3 install pyyaml pyserial paho-mqtt
+```