readme.md reformat, build_flags_template comments

README.md

@@ -14,9 +14,9 @@ Where is possible both, to configure local control/mapping between inputs and ou
 
 Scalability is virtually unlimited: Setup so many controllers you needed in most convenient places of your house - MQTT broker will allow controllers communicate each other and with Openhab and propagate commands across network
 
-Prease refer our Wiki for insructions.
+[Prease refer to our Wiki for insructions.](https://github.com/anklimov/lighthub/wiki/Configuring)
 
-Finished portation of proejct to  Arduino DUE and ESP8266 (ESP32 not tested)
+Finished portation of project to  Arduino DUE and ESP8266 (ESP32 not tested)
 
 Compiled image has been added to compiled/ folder
 use 
@@ -55,7 +55,7 @@ Portation from AVR Mega 2560 to SAM3X8E (Arduino DUE) done since v 0.96
 
 # Platforms specific details:
 
-AVR version is basic and have all functions
+AVR version is basic and has all functions
 *DMX-out is software (DMXSimple) on pin3
 
 SAM3X8E:
@@ -80,27 +80,46 @@ Please, open  /variants/arduino_due_x/variant.cpp file, then edit USART0_Handler
 void USART0_Handler(void)  __attribute__((weak));
 
 # Platformio command line build instructions
-First of all install platformio framework. http://docs.platformio.org/en/latest/installation.html
+[First of all install platformio framework.]( http://docs.platformio.org/en/latest/installation.html)  [Good tutorial for fast start in RUSSIAN.](https://geektimes.ru/post/273852/)
 
-https://geektimes.ru/post/273852/ // Good tutorial for fast start in RUSSIAN
+In linux\macOS you can open terminal, navigate to your programming directory, then
 
-In linux you can open terminal, navigate to your programming directory, then
-
-* git clone https://github.com/anklimov/lighthub.git
-* cd lighthub
-* pio init --ide clion // use your IDE, others here: http://docs.platformio.org/en/latest/ide.html
-* pio run -e due // this will build firmware for arduino due board
-* rm -Rf .piolibdeps // this will clean libraries folder. Try it if you have compilation problem
-* pio run -e megaatmega2560 //build for arduino mega
-* pio run -e due -t upload //build and upload firmware to arduino due
-* platformio device monitor -b 115200 // open com port monitor with specified baud rate
+```bash
+ git clone https://github.com/anklimov/lighthub.git
+ cd lighthub
+ ```
+now prepare project files for your IDE
+```bash
+pio init --ide [atom|clion|codeblocks|eclipse|emacs|netbeans|qtcreator|sublimetext|vim|visualstudio|vscode]
+```
+Set custom build flags. first make your own copy of template
+```bash
+cp build_flags_template.sh my_build_flags.sh
+```
+then edit, change or comment unnecessary sections and source it
+```bash
+nano my_build_flags.sh
+source my_build_flags.sh
+```
+build and upload firmware for due|megaatmega2560|esp8266 board
+```bash
+pio run -e due|megaatmega2560|esp8266 -t upload
+```
+Clean pio libraries folder. Try it if you have compilation problem:
+```bash
+rm -Rf .piolibdeps
+```
+open COM-port monitor with specified baud rate
+```bash
+platformio device monitor -b 115200
+```
 
 # Custom build flags
 
 * MY_CONFIG_SERVER=192.168.1.1 // address of external JSON-config http://192.168.1.1/de-ad-be-ef-fe-00.config.json
-* WATCH_DOG_TICKER_DISABLE=1 //disable wdt feature
+* WATCH_DOG_TICKER_DISABLE //disable wdt feature
 * USE_1W_PIN=49 // use direct connection to 1W devices on 49 pin, no I2C bridge DS2482-100
-* SD_CARD_INSERTED=1 // enable sd-card support and fix lan starting
+* SD_CARD_INSERTED // enable sd-card support and fix lan starting
 * SERIAL_BAUD=115200 // set baud rate for console on Serial0
 * Wiz5500 //Use Wiznet 5500 library instead Wiznet 5100
 * DISABLE_FREERAM_PRINT // disable printing free Ram in bytes

build_flags_template.sh

@@ -2,7 +2,9 @@
 # usage:
 # first make your own copy of template
 # cp build_flags_template.sh my_build_flags.sh
-# then source it
+# then edit, change or comment something
+# nano  my_build_flags.sh
+# and source it
 # source my_build_flags.sh
  export FLAGS="-DMY_CONFIG_SERVER=lazyhome.ru"
  export FLAGS="$FLAGS -DWATCH_DOG_TICKER_DISABLE"

platformio.ini

@@ -12,6 +12,7 @@ src_dir = lighthub
 env_default =
           megaatmega2560
 ;         due
+;         esp8266
 
 [env:due]
 platform = atmelsam
@@ -101,7 +102,7 @@ lib_deps =
           https://github.com/anklimov/Artnet.git
           FastLED
 
-[env:espressif8266]
+[env:esp8266]
 platform = espressif8266
 framework = arduino
 board = nodemcuv2