Add English README documentation for Mk2_fasterControl_Full with setu…

…p instructions and file descriptions

Mk2_fasterControl_Full/Readme.en.md

@@ -0,0 +1,63 @@
+[![en](https://img.shields.io/badge/lang-en-red.svg)](Readme.en.md)
+[![fr](https://img.shields.io/badge/lang-fr-blue.svg)](Readme.md)
+
+This program is to be used with the Arduino IDE and/or other development IDE like VSCode + PlatformIO.
+
+# Use with Arduino IDE
+
+You'll need to download and install the **latest** [Arduino IDE](https://www.arduino.cc/en/software).
+
+Download the "standalone" version, NOT the version from the Microsoft Store.
+Pick-up the "Win 10 and newer, 64 bits" or the "MSI installer" version.
+
+Since the code is optimized with the latest standard of C++, you'll need to edit a config file to activate C++17. 	
+
+Please search the file '**platform.txt**' located in the installation path of the Arduino IDE.
+
+For **Windows**, typically, you'll find the file in '**C:\Program Files (x86)\Arduino\hardware\arduino\avr**' and/or in '**%LOCALAPPDATA%\Arduino15\packages\arduino\hardware\avr\x.y.z**' where 'x.y.z' is the version of the **Arduino AVR Boards** package.
+
+You can type this command in a Powershell : `Get-Childitem –Path C:\ -Include platform.txt -Recurse -ErrorAction SilentlyContinue`. It could take a couple of seconds/minutes until the file is found.
+
+For **Linux**, if using the AppImage package, you'll find this file in '**~/.arduino15/packages/arduino/hardware/avr/1.8.6**'.  
+You can run `find / -name platform.txt 2>/dev/null` in case the location has been changed.
+
+Edit the file in any Text Editor (you'll need **Admin rights**) and replace the parameter '**-std=gnu++11**' with '**-std=gnu++17**'. That's it!	
+
+If your Arduino IDE was opened, please close all the instances and open it again.	
+
+# Use with Visual Studio Code
+
+You'll need to install additional extension(s). The most popular and used extensions for this job are '*Arduino*' and '*Platform IO*'.
+
+# Quick overview of the files
+
+- **Mk2_fasterControl_Full.ino** : This file is needed for Arduino IDE
+- **calibration.h** : contains the calibration parameters
+- **config.h** : the user's preferences are stored here (pin assignments, features, ...)
+- **config_system.h** : rarely modified system constants
+- **constants.h** : some constants - *do not edit*
+- **debug.h** : some macros for serial output and debugging
+- **dualtariff.h** : definitions for the dual tariff feature
+- **ewma_avg.h** : EWMA calculations
+- **main.cpp** : source code
+- **main.h** : functions prototypes
+- **movingAvg.h** : source code for sliding-window average
+- **processing.cpp** : source code for the processing engine
+- **processing.h** : functions prototype of the processing engine
+- **Readme.en.md** : this file
+- **types.h** : definitions of types, ...
+- **type_traits.h** : some STL stuff not yet available in the avr-package
+- **type_traits** : folder containing some missing STL helpers
+- **utils_display.h** : source code for the *7-segments display*
+- **utils_dualtariff.h** : source code *dual tariff*
+- **utils_oled.h** : source code for the *OLED-I2C display*
+- **utils_relay.h** : source code for the *relay-diversion* feature
+- **utils_rf.h** : source code for the *RF* feature
+- **utils_temp.h** : source code for the *temperature* feature
+- **utils.h** : helper functions and misc stuff
+- **validation.h** : config validation, this code is executed during compile-time only !
+- **platformio.ini** : PlatformIO configuration
+- **inject_sketch_name.py** : helper script for PlatformIO
+- **Doxyfile** : config for Doxygen (code documentation)
+
+The end-user should ONLY edit both files **calibration.h** and **config.h**.