From 72fad5384e280738553f3067a789ef6bf6c02f35 Mon Sep 17 00:00:00 2001 From: Vivian Date: Tue, 29 May 2018 15:24:10 -0700 Subject: [PATCH 1/2] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 606577d21..bf321675b 100644 --- a/README.md +++ b/README.md @@ -15,13 +15,13 @@ If you like **Sonoff-Tasmota**, give it a star, or fork it and contribute! Current version is **5.14.0b** - See [sonoff/_releasenotes.ino](https://github.com/arendst/Sonoff-Tasmota/blob/development/sonoff/_releasenotes.ino) for change information. -### Quick install +### Quick Install Download one of the released binaries from https://github.com/arendst/Sonoff-Tasmota/releases and flash it to your hardware as documented in the wiki. ### Important User Compilation Information If you want to compile Sonoff-Tasmota yourself keep in mind the following: -- Only Flash Mode **DOUT** is supported. Do not use Flash Mode DIO / QIO / QOUT as it might seem to brick your device. See [Wiki](https://github.com/arendst/Sonoff-Tasmota/wiki/Theo's-Tasmota-Tips) for background information. +- Only Flash Mode **DOUT** is supported. Do not use Flash Mode DIO / QIO / QOUT as it might brick your device. See [Wiki](https://github.com/arendst/Sonoff-Tasmota/wiki/Theo's-Tasmota-Tips) for background information. - Sonoff-Tasmota uses a 1M linker script WITHOUT spiffs **1M (no SPIFFS)** for optimal code space. If you compile using ESP/Arduino library 2.3.0 then download the provided new linker script to your Arduino IDE or Platformio base folder. Later version of ESP/Arduino library already contain the correct linker script. See [Wiki > Prerequisite](https://github.com/arendst/Sonoff-Tasmota/wiki/Prerequisite). - To make compile time changes to Sonoff-Tasmota it can use the ``user_config_override.h`` file. It assures keeping your settings when you download and compile a new version. To use ``user_config.override.h`` you will have to make a copy of the provided ``user_config.override_sample.h`` file and add your setting overrides. To enable the override file you will need to use a compile define as documented in the ``user_config_override_sample.h`` file. @@ -68,7 +68,7 @@ The following devices are supported: - [Luani HVIO board](https://luani.de/projekte/esp8266-hvio/) - Wemos D1 mini, NodeMcu and Ledunia -### Firmware release information +### Firmware Release Information Different firmware images are released based on Features and Sensors selection guided by code and memory usage. - The Minimal version allows intermediate OTA uploads to support larger versions and does NOT change any persistent parameter. @@ -129,7 +129,7 @@ Different firmware images are released based on Features and Sensors selection g | USE_ARILUX_RF | x | x | - | x | x | | USE_SR04 | x | - | - | x | x | -#### Typical file size +#### Typical File Size | ESP/Arduino library version | sonoff | classic | minimal | knx | allsensors | |-----------------------------|--------|---------|---------|------|------------| @@ -147,7 +147,7 @@ You can contribute to Sonoff-Tasmota by ### Credits -#### Libraries used +#### Libraries Used Libraries used with Sonoff-Tasmota are: - [ESP8266 core for Arduino](https://github.com/esp8266/Arduino) - [Adafruit BME680](https://github.com/adafruit/Adafruit_BME680) From a175c3d150376efd0f2e0ea926ac442a6dd18d55 Mon Sep 17 00:00:00 2001 From: Vivian Date: Tue, 29 May 2018 19:00:25 -0700 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bf321675b..cf603026b 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Download one of the released binaries from https://github.com/arendst/Sonoff-Tas ### Important User Compilation Information If you want to compile Sonoff-Tasmota yourself keep in mind the following: -- Only Flash Mode **DOUT** is supported. Do not use Flash Mode DIO / QIO / QOUT as it might brick your device. See [Wiki](https://github.com/arendst/Sonoff-Tasmota/wiki/Theo's-Tasmota-Tips) for background information. +- Only Flash Mode **DOUT** is supported. Do not use Flash Mode DIO / QIO / QOUT as it might seem to brick your device. See [Wiki](https://github.com/arendst/Sonoff-Tasmota/wiki/Theo's-Tasmota-Tips) for background information. - Sonoff-Tasmota uses a 1M linker script WITHOUT spiffs **1M (no SPIFFS)** for optimal code space. If you compile using ESP/Arduino library 2.3.0 then download the provided new linker script to your Arduino IDE or Platformio base folder. Later version of ESP/Arduino library already contain the correct linker script. See [Wiki > Prerequisite](https://github.com/arendst/Sonoff-Tasmota/wiki/Prerequisite). - To make compile time changes to Sonoff-Tasmota it can use the ``user_config_override.h`` file. It assures keeping your settings when you download and compile a new version. To use ``user_config.override.h`` you will have to make a copy of the provided ``user_config.override_sample.h`` file and add your setting overrides. To enable the override file you will need to use a compile define as documented in the ``user_config_override_sample.h`` file.