From 9b8a63da592778230a8a1e1c34b0bdeb8fe62124 Mon Sep 17 00:00:00 2001
From: rpiotrowski <robert.piotrowski1@pg.edu.pl>
Date: Sun, 1 Dec 2024 21:04:47 +0100
Subject: [PATCH] Czego barkuje w README.md

---
 README.md | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2c1df4f..00faf5f 100644
--- a/README.md
+++ b/README.md
@@ -11,32 +11,44 @@ This an example project to show the TIG (Telegraf, InfluxDB and Grafana) stack.
 ```bash 
     wsl --install
 ```
+TODO: add gif with install wsl
+
 - Install and run Docker Desktop on Windows (default options)
+  TODO: add gif with install Docker Desktop
 
 #### Run docker compose with TIG stack 
 - go to project folder (folder with docker-compose.yml file) and run command:
 ```bash 
     docker compose up
 ```
+TODO: add gif with run docker compose
+
 - open url in browser: [Grafana dashboard](http://localhost:3000/d/1Mar-DTiz/sustronicspilot3-3?from=now-15m&to=now&var-Temp_coeff_A=30&var-Temp_coeff_B=30&var-pH_coeff_A=15&var-pH_coeff_B=0&refresh=1s)  (use default credentials: admin/admin) 
+TODO: add gif with open browser with grafana
+
 - if necessary, correct the data source ID in dashboard
 ![Fix wrong ID datasource Screenshot](./grafana/fix_grafana_datasourceID.gif?raw=true "Example Screenshot")
 
 #### Connect the gateway to the computer using a USB cable (socket marked as NRF)
 
-#### Run the application to pass messages between serial and MQTT (serial_to_mqtt_bridge) (You have two options to choose from)
+TODO: add pic with NRF gateway
+
+#### Run the application to pass messages between serial (CDC ACM) and MQTT (serial_to_mqtt_bridge) (You have two options to choose from)
 Option A:
 Run app from source (serial_to_mqtt_bridge.py) (more safetly. eg. principles of security in the company): 
 - install python runtime, run in cmd: python -> pop up Microsoft Store -> Python 3.12 -> Download/Install 
+TODO: add gif with install python runtime
 - install pyserial and paho-mqtt module in python runtime, run in cmd: 
 ```bash 
 python -m pip install pyserial paho-mqtt
 ```
+TODO: add gif with install requiments
 - run app with parameter: 
 ```bash 
 python serial_to_mqtt_brigde.py COM13
 ```
   where 'COM13' is serial port to gateway/beacon.
+TODO: add gif with run app
 or 
 Option B: 
 Run compiled app (serial_to_mqtt_brigde.exe): 
@@ -45,6 +57,7 @@ Run compiled app (serial_to_mqtt_brigde.exe):
 serial_to_mqtt_brigde.exe COM13 
 ```
 where 'COM13' is serial port to gateway/beacon.
+TODO: add gif with run app
 ### Linux 
 #### MKFIFO
 ```bash
-- 
GitLab