add basic documentation to readme

lmagyar · Jan 17, 2022 · eaae463 · eaae463
1 parent b1681e1
commit eaae463
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,27 @@
 ![Tasmota logo](/tools/logo/TASMOTA_FullLogo_Vector.svg)
 
+![Warning](https://github.com/lmagyar/Tasmota/blob/master-custom/info/warning_stripe_wide.png)
+
+> This is a **fork** of the [official Tasmota firmware](https://github.com/arendst/Tasmota)!
+> 
+> Changes:
+> 
+> - contains a **PWM implementation with slower than 1Hz periods**, on how to use it see comments at the beginning of the [xdrv_128_slow_pwm driver] (https://github.com/lmagyar/Tasmota/blob/master-custom/tasmota/xdrv_128_slow_pwm.ino)
+> - disabled:
+>   - DOMOTICZ
+>   - KNX, KNX\_WEB\_MENU
+>   - EMULATION\_HUE, EMULATION\_WEMO
+> - in case of IR firmware, another build is added with disabled: IR_SEND_USE_MODULATION
+> - in case of normal firmware, another build is added with enabled: SLOW_PWM
+> - builds only these firmwares: 
+>   - tasmota
+>   - tasmota--slowpwm
+>   - tasmota-minimal
+>   - tasmota-sensors
+>   - tasmota-ir--nomodulation
+
+![Warning](https://github.com/lmagyar/Tasmota/blob/master-custom/info/warning_stripe_wide.png)
+
 Alternative firmware for [ESP8266](https://en.wikipedia.org/wiki/ESP8266) and [ESP32](https://en.wikipedia.org/wiki/ESP32) based devices with **easy configuration using webUI, OTA updates, automation using timers or rules, expandability and entirely local control over MQTT, HTTP, Serial or KNX**.
 _Written for PlatformIO with limited support for Arduino IDE._
 

diff --git a/info/warning_stripe_wide.png b/info/warning_stripe_wide.png