Merge branch 'release/v2.3.5'

Update espressif platform // Resolve #296, #297

.gitignore

@@ -3,7 +3,5 @@
 .pioenvs
 .tox
 .sconsign.dblite
-examples/ide-eclipse/.metadata
-examples/ide-eclipse/RemoteSystemsTempFiles
 docs/_build
 dist

.isort.cfg

@@ -1,3 +1,3 @@
 [settings]
 line_length=79
-known_third_party=click,requests,serial,SCons,pytest
+known_third_party=bottle,click,lockfile,pytest,requests,serial,SCons

.travis.yml

@@ -1,7 +1,3 @@
-cache:
-    directories:
-        - $HOME/.platformio
-
 language: python
 python:
     - "2.7"
@@ -13,7 +9,7 @@ env:
     - TOX_ENV=py27
 
 install:
-    - pip install tox
+    - pip install -U pip setuptools tox
 
 script:
     - tox -e $TOX_ENV

HISTORY.rst

@@ -1,8 +1,324 @@
 Release History
 ===============
 
+PlatformIO 2.0
+--------------
+
+2.3.5 (2015-11-18)
+~~~~~~~~~~~~~~~~~~
+
+* Added support of `libOpenCM3 <http://docs.platformio.org/en/latest/frameworks/libopencm3.html>`_
+  framework for Nucleo F103RB board
+  (`issue #309 <https://github.com/platformio/platformio/issues/309>`_)
+* Added support for Espressif ESP8266 ESP-12E board (NodeMCU)
+  (`issue #310 <https://github.com/platformio/platformio/issues/310>`_)
+* Added support for pySerial 3.0
+  (`issue #307 <https://github.com/platformio/platformio/issues/307>`_)
+* Updated Arduino AVR/SAM frameworks to 1.6.6
+  (`issue #321 <https://github.com/platformio/platformio/issues/321>`_)
+* Upload firmware using external programmer via `platformio run --target program <http://docs.platformio.org/en/latest/userguide/cmd_run.html#cmdoption-platformio-run-t>`__
+  target
+  (`issue #311 <https://github.com/platformio/platformio/issues/311>`_)
+* Fixed handling of upload port when ``board`` option is not specified in
+  `platformio.ini <http://docs.platformio.org/en/latest/projectconf.html>`__
+  (`issue #313 <https://github.com/platformio/platformio/issues/313>`_)
+* Fixed firmware uploading for `nordicrf51 <http://docs.platformio.org/en/latest/platforms/nordicnrf51.html>`__
+  development platform
+  (`issue #316 <https://github.com/platformio/platformio/issues/316>`_)
+* Fixed installation on Mac OS X El Capitan
+  (`issue #312 <https://github.com/platformio/platformio/issues/312>`_)
+* Fixed project generator for CLion IDE under Windows OS with invalid path to
+  executable
+  (`issue #326 <https://github.com/platformio/platformio/issues/326>`_)
+* Fixed empty list with serial ports on Mac OS X
+  (`isge #294 <https://github.com/platformio/platformio/issues/294>`_)
+* Fixed compilation error ``TWI_Disable not declared`` for Arduino Due board
+  (`issue #329 <https://github.com/platformio/platformio/issues/329>`_)
+
+2.3.4 (2015-10-13)
+~~~~~~~~~~~~~~~~~~
+
+* Full support of `CLion IDE <http://docs.platformio.org/en/latest/ide/clion.html>`_
+  including code auto-completion
+  (`issue #132 <https://github.com/platformio/platformio/issues/132>`_)
+* PlatformIO `command completion in Terminal <http://docs.platformio.org/en/latest/faq.html#command-completion-in-terminal>`_ for ``bash`` and ``zsh``
+* Added support for ubIQio Ardhat board
+  (`pull #302 <https://github.com/platformio/platformio/pull/302>`_)
+* Install SCons automatically and avoid ``error: option --single-version-externally-managed not recognized``
+  (`issue #279 <https://github.com/platformio/platformio/issues/279>`_)
+* Use Teensy CLI Loader for upload of .hex files on Mac OS X
+  (`issue #306 <https://github.com/platformio/platformio/issues/306>`_)
+* Fixed missing `framework-mbed <http://docs.platformio.org/en/latest/frameworks/mbed.html>`_
+  package for `teensy <http://docs.platformio.org/en/latest/platforms/teensy.html>`_
+  platform
+  (`issue #305 <https://github.com/platformio/platformio/issues/305>`_)
+
+2.3.3 (2015-10-02)
+~~~~~~~~~~~~~~~~~~
+
+* Added support for LightBlue Bean board
+  (`pull #292 <https://github.com/platformio/platformio/pull/292>`_)
+* Added support for ST Nucleo F446RE board
+  (`pull #293 <https://github.com/platformio/platformio/pull/293>`_)
+* Fixed broken lock file for "appstate" storage
+  (`issue #288 <https://github.com/platformio/platformio/issues/288>`_)
+* Fixed ESP8266 compile errors about RAM size when adding 1 library
+  (`issue #296 <https://github.com/platformio/platformio/issues/296>`_)
+
+2.3.2 (2015-09-10)
+~~~~~~~~~~~~~~~~~~
+
+* Allowed to use ST-Link uploader for mbed-based projects
+* Explained how to use ``lib`` directory from the PlatformIO based project in
+  ``readme.txt`` which will be automatically generated using
+  `platformio init <http://docs.platformio.org/en/latest/userguide/cmd_init.html>`__
+  command
+  (`issue #273 <https://github.com/platformio/platformio/issues/273>`_)
+* Found solution for "pip/scons error: option --single-version-externally-managed not
+  recognized" when install PlatformIO using ``pip`` package manager
+  (`issue #279 <https://github.com/platformio/platformio/issues/279>`_)
+* Fixed firmware uploading to Arduino Leonardo board using Mac OS
+  (`issue #287 <https://github.com/platformio/platformio/issues/287>`_)
+* Fixed `SConsNotInstalled` error for Linux Debian-based distributives
+
+2.3.1 (2015-09-06)
+~~~~~~~~~~~~~~~~~~
+
+* Fixed critical issue when `platformio init --ide <http://docs.platformio.org/en/latest/userguide/cmd_init.html>`__ command hangs PlatformIO
+  (`issue #283 <https://github.com/platformio/platformio/issues/283>`_)
+
+2.3.0 (2015-09-05)
+~~~~~~~~~~~~~~~~~~
+
+* Added
+  `native <http://docs.platformio.org/en/latest/platforms/native.html>`__,
+  `linux_arm <http://docs.platformio.org/en/latest/platforms/linux_arm.html>`__,
+  `linux_i686 <http://docs.platformio.org/en/latest/platforms/linux_i686.html>`__,
+  `linux_x86_64 <http://docs.platformio.org/en/latest/platforms/linux_x86_64.html>`__,
+  `windows_x86 <http://docs.platformio.org/en/latest/platforms/windows_x86.html>`__
+  development platforms
+  (`issue #263 <https://github.com/platformio/platformio/issues/263>`_)
+* Added `PlatformIO Demo <http://docs.platformio.org/en/latest/demo.html>`_
+  page to documentation
+* Simplified `installation <http://docs.platformio.org/en/latest/installation.html>`__
+  process of PlatformIO
+  (`issue #274 <https://github.com/platformio/platformio/issues/274>`_)
+* Significantly improved `Project Generator <http://docs.platformio.org/en/latest/userguide/cmd_init.html#cmdoption-platformio-init--ide>`__ which allows to integrate with `the most popular
+  IDE <http://docs.platformio.org/en/latest/ide.html>`__
+* Added short ``-h`` help option for PlatformIO and sub-commands
+* Updated `mbed <http://docs.platformio.org/en/latest/frameworks/mbed.html>`__
+  framework
+* Updated ``tool-teensy`` package for `Teensy <http://docs.platformio.org/en/latest/platforms/teensy.html>`__
+  platform
+  (`issue #268 <https://github.com/platformio/platformio/issues/268>`_)
+* Added FAQ answer when `Program "platformio" not found in PATH <http://docs.platformio.org/en/latest/faq.html#faq-troubleshooting-pionotfoundinpath>`_
+  (`issue #272 <https://github.com/platformio/platformio/issues/272>`_)
+* Generate "readme.txt" for project "lib" directory
+  (`issue #273 <https://github.com/platformio/platformio/issues/273>`_)
+* Use toolchain's includes pattern ``include*`` for Project Generator
+  (`issue #277 <https://github.com/platformio/platformio/issues/277>`_)
+* Added support for Adafruit Gemma board to
+  `atmelavr <http://docs.platformio.org/en/latest/platforms/atmelavr.html#boards>`__
+  platform
+  (`pull #256 <https://github.com/platformio/platformio/pull/256>`_)
+* Fixed includes list for Windows OS when generating project for `Eclipse IDE <http://docs.platformio.org/en/latest/ide/eclipse.html>`__
+  (`issue #270 <https://github.com/platformio/platformio/issues/270>`_)
+* Fixed ``AttributeError: 'module' object has no attribute 'packages'``
+  (`issue #252 <https://github.com/platformio/platformio/issues/252>`_)
+
+2.2.2 (2015-07-30)
+~~~~~~~~~~~~~~~~~~
+
+* Integration with `Atom IDE <http://docs.platformio.org/en/latest/ide/atom.html>`__
+* Support for off-line/unpublished/private libraries
+  (`issue #260 <https://github.com/platformio/platformio/issues/260>`_)
+* Disable project auto-clean while building/uploading firmware using
+  `platformio run --disable-auto-clean <http://docs.platformio.org/en/latest/userguide/cmd_run.html#cmdoption--disable-auto-clean>`_ option
+  (`issue #255 <https://github.com/platformio/platformio/issues/255>`_)
+* Show internal errors from "Miniterm" using `platformio serialports monitor <http://docs.platformio.org/en/latest/userguide/cmd_serialports.html#platformio-serialports-monitor>`__ command
+  (`issue #257 <https://github.com/platformio/platformio/issues/257>`_)
+* Fixed `platformio serialports monitor --help <http://docs.platformio.org/en/latest/userguide/cmd_serialports.html#platformio-serialports-monitor>`__ information with HEX char for hotkeys
+  (`issue #253 <https://github.com/platformio/platformio/issues/253>`_)
+* Handle "OSError: [Errno 13] Permission denied" for PlatformIO installer script
+  (`issue #254 <https://github.com/platformio/platformio/issues/254>`_)
+
+2.2.1 (2015-07-17)
+~~~~~~~~~~~~~~~~~~
+
+* Project generator for `CLion IDE <http://docs.platformio.org/en/latest/ide/clion.html>`__
+  (`issue #132 <https://github.com/platformio/platformio/issues/132>`_)
+* Updated ``tool-bossac`` package to 1.5 version for `atmelsam <http://docs.platformio.org/en/latest/platforms/atmelsam.html>`__ platform
+  (`issue #251 <https://github.com/platformio/platformio/issues/251>`_)
+* Updated ``sdk-esp8266`` package for `espressif <http://docs.platformio.org/en/latest/platforms/espressif.html>`__ platform
+* Fixed incorrect arguments handling for `platformio serialports monitor <http://docs.platformio.org/en/latest/userguide/cmd_serialports.html#platformio-serialports-monitor>`_ command
+  (`issue #248 <https://github.com/platformio/platformio/issues/248>`_)
+
+2.2.0 (2015-07-01)
+~~~~~~~~~~~~~~~~~~
+
+* Allowed to exclude/include source files from build process using
+  `src_filter <http://docs.platformio.org/en/latest/projectconf.html#src-filter>`__
+  (`issue #240 <https://github.com/platformio/platformio/issues/240>`_)
+* Launch own extra script before firmware building/uploading processes
+  (`issue #239 <https://github.com/platformio/platformio/issues/239>`_)
+* Specify own path to the linker script (ld) using
+  `build_flags <http://docs.platformio.org/en/latest/projectconf.html#build-flags>`__
+  option
+  (`issue #233 <https://github.com/platformio/platformio/issues/233>`_)
+* Specify library compatibility with the all platforms/frameworks
+  using ``*`` symbol in
+  `library.json <http://docs.platformio.org/en/latest/librarymanager/config.html>`__
+* Added support for new embedded boards: *ST 32L0538DISCOVERY and Delta DFCM-NNN40*
+  to `Framework mbed <http://docs.platformio.org/en/latest/frameworks/mbed.html>`__
+* Updated packages for
+  `Framework Arduino (AVR, SAM, Espressif and Teensy cores <http://docs.platformio.org/en/latest/frameworks/arduino.html>`__,
+  `Framework mbed <http://docs.platformio.org/en/latest/frameworks/mbed.html>`__,
+  `Espressif ESP8266 SDK <http://docs.platformio.org/en/latest/platforms/espressif.html>`__
+  (`issue #246 <https://github.com/platformio/platformio/issues/246>`_)
+* Fixed ``stk500v2_command(): command failed``
+  (`issue #238 <https://github.com/platformio/platformio/issues/238>`_)
+* Fixed IDE project generator when board is specified
+  (`issue #242 <https://github.com/platformio/platformio/issues/242>`_)
+* Fixed relative path for includes when generating project for IDE
+  (`issue #243 <https://github.com/platformio/platformio/issues/243>`_)
+* Fixed ESP8266 native SDK exception
+  (`issue #245 <https://github.com/platformio/platformio/issues/245>`_)
+
+2.1.2 (2015-06-21)
+~~~~~~~~~~~~~~~~~~
+
+* Fixed broken link to SCons installer
+
+2.1.1 (2015-06-09)
+~~~~~~~~~~~~~~~~~~
+
+* Automatically detect upload port using VID:PID board settings
+  (`issue #231 <https://github.com/platformio/platformio/issues/231>`_)
+* Improved detection of build changes
+* Avoided ``LibInstallDependencyError`` when more then 1 library is found
+  (`issue #229 <https://github.com/platformio/platformio/issues/229>`_)
+
+2.1.0 (2015-06-03)
+~~~~~~~~~~~~~~~~~~
+
+* Added Silicon Labs EFM32 `siliconlabsefm32 <http://docs.platformio.org/en/latest/platforms/siliconlabsefm32.html>`_
+  development platform
+  (`issue #226 <https://github.com/platformio/platformio/issues/226>`_)
+* Integrate PlatformIO with `Circle CI <https://circleci.com>`_ and
+  `Shippable CI <https://shippable.com>`_
+* Described in documentation how to `create/register own board <http://docs.platformio.org/en/latest/platforms/creating_board.html>`_ for PlatformIO
+* Disabled "nano.specs" for ARM-based platforms
+  (`issue #219 <https://github.com/platformio/platformio/issues/219>`_)
+* Fixed "ConnectionError" when PlatformIO SF Storage is off-line
+* Fixed resolving of C/C++ std libs by Eclipse IDE
+  (`issue #220 <https://github.com/platformio/platformio/issues/220>`_)
+* Fixed firmware uploading using USB programmer (USBasp) for
+  `atmelavr <http://docs.platformio.org/en/latest/platforms/atmelavr.html>`_
+  platform
+  (`issue #221 <https://github.com/platformio/platformio/issues/221>`_)
+
+2.0.2 (2015-05-27)
+~~~~~~~~~~~~~~~~~~
+
+* Fixed libraries order for "Library Dependency Finder" under Linux OS
+
+2.0.1 (2015-05-27)
+~~~~~~~~~~~~~~~~~~
+
+* Handle new environment variable
+  `PLATFORMIO_BUILD_FLAGS <http://docs.platformio.org/en/latest/envvars.html#platformio-build-flags>`_
+* Pass to API requests information about Continuous Integration system. This
+  information will be used by PlatformIO-API.
+* Use ``include`` directories from toolchain when initialising project for IDE
+  (`issue #210 <https://github.com/platformio/platformio/issues/210>`_)
+* Added support for new WildFire boards from
+  `Wicked Device <http://wickeddevice.com>`_ to
+  `atmelavr <http://docs.platformio.org/en/latest/platforms/atmelavr.html#boards>`__
+  platform
+* Updated `Arduino Framework <http://docs.platformio.org/en/latest/frameworks/arduino.html>`__ to
+  1.6.4 version (`issue #212 <https://github.com/platformio/platformio/issues/212>`_)
+* Handle Atmel AVR Symbols when initialising project for IDE
+  (`issue #216 <https://github.com/platformio/platformio/issues/216>`_)
+* Fixed bug with converting ``*.ino`` to ``*.cpp``
+* Fixed failing with ``platformio init --ide eclipse`` without boards
+  (`issue #217 <https://github.com/platformio/platformio/issues/217>`_)
+
+2.0.0 (2015-05-22)
+~~~~~~~~~~~~~~~~~~
+
+*Made in* `Paradise <https://twitter.com/ikravets/status/592356377185619969>`_
+
+* PlatformIO as `Continuous Integration <http://docs.platformio.org/en/latest/ci/index.html>`_
+  (CI) tool for embedded projects
+  (`issue #108 <https://github.com/platformio/platformio/issues/108>`_)
+* Initialise PlatformIO project for the specified IDE
+  (`issue #151 <https://github.com/platformio/platformio/issues/151>`_)
+* PlatformIO CLI 2.0: "platform" related commands have been
+  moved to ``platformio platforms`` subcommand
+  (`issue #158 <https://github.com/platformio/platformio/issues/158>`_)
+* Created `PlatformIO gitter.im <https://gitter.im/platformio/platformio>`_ room
+  (`issue #174 <https://github.com/platformio/platformio/issues/174>`_)
+* Global ``-f, --force`` option which will force to accept any
+  confirmation prompts
+  (`issue #152 <https://github.com/platformio/platformio/issues/152>`_)
+* Run project with `platformio run --project-dir <http://docs.platformio.org/en/latest/userguide/cmd_run.html#cmdoption--project-dir>`_ option without changing the current working
+  directory
+  (`issue #192 <https://github.com/platformio/platformio/issues/192>`_)
+* Control verbosity of `platformio run <http://docs.platformio.org/en/latest/userguide/cmd_run.html#cmdoption-platformio-run-v>`_ command via ``-v/--verbose`` option
+* Add library dependencies for build environment using
+  `lib_install <http://docs.platformio.org/en/latest/projectconf.html#lib-install>`_
+  option in ``platformio.ini``
+  (`issue #134 <https://github.com/platformio/platformio/issues/134>`_)
+* Specify libraries which are compatible with build environment using
+  `lib_use <http://docs.platformio.org/en/latest/projectconf.html#lib-use>`_
+  option in ``platformio.ini``
+  (`issue #148 <https://github.com/platformio/platformio/issues/148>`_)
+* Add more boards to PlatformIO project with
+  `platformio init --board <http://docs.platformio.org/en/latest/userguide/cmd_init.html#cmdoption--board>`__
+  command
+  (`issue #167 <https://github.com/platformio/platformio/issues/167>`_)
+* Choose which library to update
+  (`issue #168 <https://github.com/platformio/platformio/issues/168>`_)
+* Specify `platformio init --env-prefix <http://docs.platformio.org/en/latest/userguide/cmd_init.html#cmdoption--env-prefix>`__ when initialise/update project
+  (`issue #182 <https://github.com/platformio/platformio/issues/182>`_)
+* Added new Armstrap boards
+  (`issue #204 <https://github.com/platformio/platformio/issues/204>`_)
+* Updated SDK for `espressif <http://docs.platformio.org/en/latest/platforms/espressif.html>`__
+  development platform to v1.1
+  (`issue #179 <https://github.com/platformio/platformio/issues/179>`_)
+* Disabled automatic updates by default for platforms, packages and libraries
+  (`issue #171 <https://github.com/platformio/platformio/issues/171>`_)
+* Fixed bug with creating copies of source files
+  (`issue #177 <https://github.com/platformio/platformio/issues/177>`_)
+
+PlatformIO 1.0
+--------------
+
+1.5.0 (2015-05-15)
+~~~~~~~~~~~~~~~~~~
+
+* Added support of `Framework mbed <http://platformio.org/#!/frameworks/mbed>`_
+  for Teensy 3.1
+  (`issue #183 <https://github.com/platformio/platformio/issues/183>`_)
+* Added GDB as alternative uploader to `ststm32 <http://docs.platformio.org/en/latest/platforms/ststm32.html>`__ platform
+  (`issue #175 <https://github.com/platformio/platformio/issues/174>`_)
+* Added `examples <https://github.com/platformio/platformio/tree/develop/examples>`__
+  with preconfigured IDE projects
+  (`issue #154 <https://github.com/platformio/platformio/issues/154>`_)
+* Fixed firmware uploading under Linux OS for Arduino Leonardo board
+  (`issue #178 <https://github.com/platformio/platformio/issues/178>`_)
+* Fixed invalid "mbed" firmware for Nucleo F411RE
+  (`issue #185 <https://github.com/platformio/platformio/issues/185>`_)
+* Fixed parsing of includes for PlatformIO Library Dependency Finder
+  (`issue #189 <https://github.com/platformio/platformio/issues/189>`_)
+* Fixed handling symbolic links within source code directory
+  (`issue #190 <https://github.com/platformio/platformio/issues/190>`_)
+* Fixed cancelling any previous definition of name, either built in or provided
+  with a ``-D`` option
+  (`issue #191 <https://github.com/platformio/platformio/issues/191>`_)
+
 1.4.0 (2015-04-11)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Added `espressif <http://docs.platformio.org/en/latest/platforms/espressif.html>`_
   development platform with ESP01 board
@@ -12,22 +328,23 @@ Release History
   `teensy <http://docs.platformio.org/en/latest/platforms/teensy.html>`__
   platform
 * Added support for new Arduino based boards by *SparkFun, BQ, LightUp,
-  LowPowerLab, Quirkbot, RedBearLab, TinyCircuits, WickedDevice* to
+  LowPowerLab, Quirkbot, RedBearLab, TinyCircuits* to
   `atmelavr <http://docs.platformio.org/en/latest/platforms/atmelavr.html#boards>`__
   platform
 * Upgraded `Arduino Framework <http://docs.platformio.org/en/latest/frameworks/arduino.html>`__ to
   1.6.3 version (`issue #156 <https://github.com/platformio/platformio/issues/156>`_)
 * Upgraded `Energia Framework <http://docs.platformio.org/en/latest/frameworks/energia.html>`__ to
   0101E0015 version (`issue #146 <https://github.com/platformio/platformio/issues/146>`_)
-* Upgraded `Arduino Framework with Teensy Core <http://docs.platformio.org/en/latest/frameworks/arduino.html>`_ to
-  1.22 version (`issue #162 <https://github.com/platformio/platformio/issues/162>`_,
+* Upgraded `Arduino Framework with Teensy Core <http://docs.platformio.org/en/latest/frameworks/arduino.html>`_
+  to 1.22 version
+  (`issue #162 <https://github.com/platformio/platformio/issues/162>`_,
   `issue #170 <https://github.com/platformio/platformio/issues/170>`_)
 * Fixed exceptions with PlatformIO auto-updates when Internet connection isn't
   active
 
 
 1.3.0 (2015-03-27)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Moved PlatformIO source code and repositories from `Ivan Kravets <https://github.com/ivankravets>`_
   account to `PlatformIO Organisation <https://github.com/platformio>`_
@@ -48,7 +365,7 @@ Release History
 
 
 1.2.0 (2015-03-20)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Added full support of `mbed <http://docs.platformio.org/en/latest/frameworks/mbed.html>`__
   framework including libraries: *RTOS, Ethernet, DSP, FAT, USB*.
@@ -80,7 +397,7 @@ Release History
   (`issue #100 <https://github.com/platformio/platformio/issues/100>`_)
 
 1.1.0 (2015-03-05)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Implemented ``PLATFORMIO_*`` environment variables
   (`issue #102 <https://github.com/platformio/platformio/issues/102>`_)
@@ -98,7 +415,7 @@ Release History
 * Fixed uploading for *Digispark* board (`issue #106 <https://github.com/platformio/platformio/issues/106>`_)
 
 1.0.1 (2015-02-27)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 **PlatformIO 1.0 - recommended for production**
 
@@ -144,7 +461,7 @@ Release History
   commands which allows to return the output in `JSON <http://en.wikipedia.org/wiki/JSON>`_ format
   (`issue #42 <https://github.com/platformio/platformio/issues/42>`_)
 * Allowed to ignore some libs from *Library Dependency Finder* via
-  `ignore_libs <http://docs.platformio.org/en/latest/projectconf.html#ignore-libs>`_ option
+  `lib_ignore <http://docs.platformio.org/en/latest/projectconf.html#lib-ignore>`_ option
 * Improved `platformio run <http://docs.platformio.org/en/latest/userguide/cmd_run.html>`__
   command: asynchronous output for build process, timing and detailed
   information about environment configuration
@@ -165,9 +482,11 @@ Release History
   error (`issue #81 <https://github.com/platformio/platformio/issues/81>`_)
 * Several bug fixes, increased stability and performance improvements
 
+PlatformIO 0.0
+--------------
 
 0.10.2 (2015-01-06)
--------------------
+~~~~~~~~~~~~~~~~~~~
 
 * Fixed an issue with ``--json-output``
   (`issue #42 <https://github.com/platformio/platformio/issues/42>`_)
@@ -176,7 +495,7 @@ Release History
   under Windows OS (`issue #45 <https://github.com/platformio/platformio/issues/45>`_)
 
 0.10.1 (2015-01-02)
--------------------
+~~~~~~~~~~~~~~~~~~~
 
 * Added ``--json-output`` option to
   `platformio list <http://docs.platformio.org/en/latest/userguide/cmd_list.html>`__,
@@ -188,7 +507,7 @@ Release History
   command
 
 0.10.0 (2015-01-01)
--------------------
+~~~~~~~~~~~~~~~~~~~
 
 **Happy New Year!**
 
@@ -211,7 +530,7 @@ Release History
 * Fixed bug with *Arduino USB* boards (`issue #40 <https://github.com/platformio/platformio/issues/40>`_)
 
 0.9.2 (2014-12-10)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Replaced "dark blue" by "cyan" colour for the texts (`issue #33 <https://github.com/platformio/platformio/issues/33>`_)
 * Added new setting `enable_prompts <http://docs.platformio.org/en/latest/userguide/cmd_settings.html>`_
@@ -220,7 +539,7 @@ Release History
 * Fixed compilation bug on *Windows* with installed *MSVC* (`issue #18 <https://github.com/platformio/platformio/issues/18>`_)
 
 0.9.1 (2014-12-05)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Ask user to install platform (when it hasn't been installed yet) within
   `platformio run <http://docs.platformio.org/en/latest/userguide/cmd_run.html>`__
@@ -229,13 +548,13 @@ Release History
 * Fixed "*OSError: [Errno 2] No such file or directory*" within
   `platformio run <http://docs.platformio.org/en/latest/userguide/cmd_run.html>`__
   command when PlatformIO isn't installed properly
-* Fixed example for `Eclipse IDE with Tiva board <https://github.com/platformio/platformio/tree/develop/examples/ide-eclipse>`_
+* Fixed example for `Eclipse IDE with Tiva board <https://github.com/platformio/platformio/tree/develop/examples/ide/eclipse>`_
   (`issue #32 <https://github.com/platformio/platformio/pull/32>`_)
-* Upgraded `Eclipse Project Examples <https://github.com/platformio/platformio/tree/develop/examples/ide-eclipse>`_
+* Upgraded `Eclipse Project Examples <https://github.com/platformio/platformio/tree/develop/examples/ide/eclipse>`_
   to latest *Luna* and *PlatformIO* releases
 
 0.9.0 (2014-12-01)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Implemented `platformio settings <http://docs.platformio.org/en/latest/userguide/cmd_settings.html>`_ command
 * Improved `platformio init <http://docs.platformio.org/en/latest/userguide/cmd_init.html>`_ command.
@@ -253,7 +572,7 @@ Release History
   (`issue #28 <https://github.com/platformio/platformio/issues/28>`_)
 
 0.8.0 (2014-10-19)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Avoided trademark issues in `library.json <http://docs.platformio.org/en/latest/librarymanager/config.html>`_
   with the new fields: `frameworks <http://docs.platformio.org/en/latest/librarymanager/config.html#frameworks>`_,
@@ -270,7 +589,7 @@ Release History
   command: ``--framework`` and ``--platform``
 
 0.7.1 (2014-10-06)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Fixed bug with order for includes in conversation from INO/PDE to CPP
 * Automatic detection of port on upload (`issue #15 <https://github.com/platformio/platformio/issues/15>`_)
@@ -278,7 +597,7 @@ Release History
 
 
 0.7.0 (2014-09-24)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Implemented new `[platformio] <http://docs.platformio.org/en/latest/projectconf.html#platformio>`_
   section for Configuration File with `home_dir <http://docs.platformio.org/en/latest/projectconf.html#home-dir>`_
@@ -286,14 +605,14 @@ Release History
 * Implemented *Library Manager* (`issue #6 <https://github.com/platformio/platformio/issues/6>`_)
 
 0.6.0 (2014-08-09)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Implemented `platformio serialports monitor <http://docs.platformio.org/en/latest/userguide/cmd_serialports.html#platformio-serialports-monitor>`_ (`issue #10 <https://github.com/platformio/platformio/issues/10>`_)
 * Fixed an issue ``ImportError: No module named platformio.util`` (`issue #9 <https://github.com/platformio/platformio/issues/9>`_)
 * Fixed bug with auto-conversation from Arduino \*.ino to \*.cpp
 
 0.5.0 (2014-08-04)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Improved nested lookups for libraries
 * Disabled default warning flag "-Wall"
@@ -308,14 +627,14 @@ Release History
 * Fixed a bug with nested libs building
 
 0.4.0 (2014-07-31)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Implemented `platformio serialports <http://docs.platformio.org/en/latest/userguide/cmd_serialports.html>`_ command
 * Allowed to put special build flags only for ``src`` files via
-  `srcbuild_flags <http://docs.platformio.org/en/latest/projectconf.html#srcbuild-flags>`_
+  `src_build_flags <http://docs.platformio.org/en/latest/projectconf.html#src_build-flags>`_
   environment option
 * Allowed to override some of settings via system environment variables
-  such as: ``PLATFORMIO_SRCBUILD_FLAGS`` and ``PLATFORMIO_ENVS_DIR``
+  such as: ``PLATFORMIO_SRC_BUILD_FLAGS`` and ``PLATFORMIO_ENVS_DIR``
 * Added ``--upload-port`` option for `platformio run <http://docs.platformio.org/en/latest/userguide/cmd_run.html#cmdoption--upload-port>`__ command
 * Implemented (especially for `SmartAnthill <http://docs.smartanthill.ikravets.com/>`_)
   `platformio run -t uploadlazy <http://docs.platformio.org/en/latest/userguide/cmd_run.html>`_
@@ -328,13 +647,13 @@ Release History
 
 
 0.3.1 (2014-06-21)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Fixed auto-installer for Windows OS (bug with %PATH% customisations)
 
 
 0.3.0 (2014-06-21)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Allowed to pass multiple "SomePlatform" to install/uninstall commands
 * Added "IDE Integration" section to README with Eclipse project examples
@@ -344,7 +663,7 @@ Release History
 
 
 0.2.0 (2014-06-15)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Resolved `issue #1 "Build referred libraries" <https://github.com/platformio/platformio/issues/1>`_
 * Renamed project's "libs" directory to "lib"
@@ -353,6 +672,6 @@ Release History
 
 
 0.1.0 (2014-06-13)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Birth! First alpha release

LICENSE

@@ -1,21 +1,174 @@
-The MIT License (MIT)
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
 
-Copyright (c) 2014-2015 Ivan Kravets
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+1. Definitions.
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+  Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+  stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+  that You distribute, all copyright, patent, trademark, and
+  attribution notices from the Source form of the Work,
+  excluding those notices that do not pertain to any part of
+  the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+  distribution, then any Derivative Works that You distribute must
+  include a readable copy of the attribution notices contained
+  within such NOTICE file, excluding those notices that do not
+  pertain to any part of the Derivative Works, in at least one
+  of the following places: within a NOTICE text file distributed
+  as part of the Derivative Works; within the Source form or
+  documentation, if provided along with the Derivative Works; or,
+  within a display generated by the Derivative Works, if and
+  wherever such third-party notices normally appear. The contents
+  of the NOTICE file are for informational purposes only and
+  do not modify the License. You may add Your own attribution
+  notices within Derivative Works that You distribute, alongside
+  or as an addendum to the NOTICE text from the Work, provided
+  that such additional attribution notices cannot be construed
+  as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.

README.rst

@@ -4,37 +4,54 @@ PlatformIO
 .. image:: https://travis-ci.org/platformio/platformio.svg?branch=develop
     :target: https://travis-ci.org/platformio/platformio
     :alt: Travis.CI Build Status
-.. image:: https://ci.appveyor.com/api/projects/status/ee26e58de798rctd/branch/develop?svg=true
+.. image:: https://ci.appveyor.com/api/projects/status/dku0h2rutfj0ctls/branch/develop?svg=true
     :target: https://ci.appveyor.com/project/ivankravets/platformio
-    :alt: AppVeyor.CI Build Status    
-.. image:: https://gemnasium.com/ivankravets/platformio.png
-    :target: https://gemnasium.com/ivankravets/platformio
-    :alt: Dependency Status
-.. image:: https://pypip.in/version/platformio/badge.png?style=flat
+    :alt: AppVeyor.CI Build Status
+.. image:: https://circleci.com/gh/platformio/platformio/tree/develop.svg?style=svg
+    :target: https://circleci.com/gh/platformio/platformio/tree/develop
+    :alt: Circle.CI Build Status
+.. image:: https://requires.io/github/platformio/platformio/requirements.svg?branch=develop
+    :target: https://requires.io/github/platformio/platformio/requirements/?branch=develop
+    :alt: Requirements Status
+.. image:: https://img.shields.io/pypi/v/platformio.svg
     :target: https://pypi.python.org/pypi/platformio/
     :alt: Latest Version
-.. image:: https://pypip.in/download/platformio/badge.png?style=flat
-    :target: https://pypi.python.org/pypi/platformio/
-    :alt: Downloads
-.. image:: https://pypip.in/license/platformio/badge.png?style=flat
+.. image:: https://img.shields.io/pypi/l/platformio.svg
     :target: https://pypi.python.org/pypi/platformio/
     :alt:  License
+.. image:: https://img.shields.io/pypi/dm/platformio.svg
+    :target: https://pypi.python.org/pypi/platformio/
+    :alt: PyPi Downloads
+.. image:: https://img.shields.io/sourceforge/dm/platformio-storage.svg
+    :target: https://sourceforge.net/projects/platformio-storage/
+    :alt: Packages Downloads
+.. image:: https://badges.gitter.im/Join%20Chat.svg
+   :alt: Join the chat at https://gitter.im/platformio/platformio
+   :target: https://gitter.im/platformio/platformio
 
-`Website + Library Search <http://platformio.org>`_ |
-`Documentation <http://docs.platformio.org>`_ |
+`Home & Demo <http://platformio.org>`_ |
 `Project Examples <https://github.com/platformio/platformio/tree/develop/examples>`_ |
+`Source Code <https://github.com/platformio>`_ |
+`Documentation <http://docs.platformio.org>`_ ||
 `Blog <http://www.ikravets.com/category/computer-life/platformio>`_ |
-`Reddit <http://www.reddit.com/r/platformio/>`_ |
-`Twitter <https://twitter.com/PlatformIO_Org>`_
-
-*Atmel AVR & SAM, Freescale Kinetis, Nordic nRF51, NXP LPC, ST STM32,
-TI MSP430 & Tiva, Teensy, Arduino, mbed, libOpenCM3, etc.*
+`Twitter <https://twitter.com/PlatformIO_Org>`_ |
+`Hackaday <https://hackaday.io/project/7980-platformio>`_ |
+`Facebook <https://www.facebook.com/platformio>`_ |
+`Reddit <http://www.reddit.com/r/platformio/>`_
 
 .. image:: https://raw.githubusercontent.com/platformio/platformio/develop/docs/_static/platformio-logo.png
     :target: http://platformio.org
 
-`PlatformIO <http://platformio.org>`_ is a cross-platform code builder
-and the missing library manager.
+`PlatformIO <http://platformio.org>`_ is an open-source cross-platform code
+builder and the missing library manager (Ready for embedded development, IDE
+and Continuous integration, Arduino and MBED compatible).
+
+*Atmel AVR & SAM, Espressif, Freescale Kinetis, Nordic nRF51, NXP LPC,
+Silicon Labs EFM32, ST STM32, TI MSP430 & Tiva, Teensy, Arduino, mbed,
+libOpenCM3, etc.*
+
+.. image:: https://raw.githubusercontent.com/platformio/platformio/develop/docs/_static/platformio-demo-wiring.gif
+    :target: http://platformio.org
 
 * `Get Started <http://platformio.org/#!/get-started>`_
 * `Web 2.0 Library Search <http://platformio.org/#!/lib>`_
@@ -43,6 +60,7 @@ and the missing library manager.
 * `Embedded Boards Explorer <http://platformio.org/#!/boards>`_
 * `Library Manager <http://docs.platformio.org/en/latest/librarymanager/index.html>`_
 * `User Guide <http://docs.platformio.org/en/latest/userguide/index.html>`_
+* `Continuous Integration <http://docs.platformio.org/en/latest/ci/index.html>`_
 * `IDE Integration <http://docs.platformio.org/en/latest/ide.html>`_
 * `Articles about us <http://docs.platformio.org/en/latest/articles.html>`_
 * `FAQ <http://docs.platformio.org/en/latest/faq.html>`_
@@ -68,11 +86,13 @@ Embedded Development. *Easier Than Ever.*
 settings for most popular `Embedded Boards <http://platformio.org/#!/boards>`_.
 
 * Colourful `command-line output <https://raw.githubusercontent.com/platformio/platformio/develop/examples/platformio-examples.png>`_
-* Built-in `Serial Port Monitor <http://docs.platformio.org/en/latest/userguide/cmd_serialports.html#platformio-serialports-monitor>`_
-* Configurable `build -flags/-options <http://docs.platformio.org/en/latest/projectconf.html#build-flags>`_
+* `IDE Integration <http://docs.platformio.org/en/latest/ide.html>`_ with
+  *Arduino, Eclipse, Energia, Qt Creator, Sublime Text, Vim, Visual Studio*
+* `Continuous Integration <http://docs.platformio.org/en/latest/ci/index.html>`_
+  with *AppVeyor, Circle CI, Drone, Shippable, Travis CI*
+* Built-in `Serial Port Monitor <http://docs.platformio.org/en/latest/userguide/cmd_serialports.html#platformio-serialports-monitor>`_ and configurable
+  `build -flags/-options <http://docs.platformio.org/en/latest/projectconf.html#build-flags>`_
 * Automatic **firmware uploading**
-* Integration with `development environments (IDE) <http://docs.platformio.org/en/latest/ide.html>`_
-* Ready for **Cloud Compiling** and **Continuous Integration**
 * Pre-built tool chains, frameworks for the popular `Hardware Platforms <http://platformio.org/#!/platforms>`_
 
 .. image:: https://raw.githubusercontent.com/platformio/platformio-web/develop/app/images/platformio-embedded-development.png
@@ -127,10 +147,12 @@ It has support for the most popular embedded platforms:
 
 * `Atmel AVR <http://platformio.org/#!/platforms/atmelavr>`_
 * `Atmel SAM <http://platformio.org/#!/platforms/atmelsam>`_
+* `Espressif <http://platformio.org/#!/platforms/espressif>`_
 * `Freescale Kinetis <http://platformio.org/#!/platforms/freescalekinetis>`_
 * `Nordic nRF51 <http://platformio.org/#!/platforms/nordicnrf51>`_
-* `NXP LPC. <http://platformio.org/#!/platforms/nxplpc>`_
+* `NXP LPC <http://platformio.org/#!/platforms/nxplpc>`_
 * `ST STM32 <http://platformio.org/#!/platforms/ststm32>`_
+* `Silicon Labs EFM32 <http://platformio.org/#!/platforms/siliconlabsefm32>`_
 * `Teensy <http://platformio.org/#!/platforms/teensy>`_
 * `TI MSP430 <http://platformio.org/#!/platforms/timsp430>`_
 * `TI TIVA C <http://platformio.org/#!/platforms/titiva>`_
@@ -148,6 +170,7 @@ Frameworks:
 Licence
 -------
 
-Copyright (C) 2014-2015 Ivan Kravets
+Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
 
-Licenced under the MIT Licence.
+The PlatformIO is licensed under the permissive Apache 2.0 licence,
+so you can use it in both commercial and personal projects with confidence.

appveyor.yml

@@ -9,12 +9,18 @@ environment:
       PYTHON_HOME: "C:\\Python27-x64"
       PYTHON_VERSION: "2.7"
       PYTHON_ARCH: "64"
+      
 init:
   - "ECHO %TOXENV%"
   - ps: "ls C:\\Python*"
+  
 install:
   - "git submodule update --init --recursive"
   - "powershell scripts\\appveyor\\install.ps1"
+  
+before_test:
+  - cmd: SET PATH=%PATH%;C:\MinGW\bin  
+  
 test_script:
   - "%PYTHON_HOME%\\Scripts\\tox --version"
   - "%PYTHON_HOME%\\Scripts\\pip --version"

circle.yml

@@ -0,0 +1,21 @@
+machine:
+    python:
+        version: 2.7
+    environment:
+        TOX_ENV: docs
+        TOX_ENV: lint
+        TOX_ENV: py26
+        TOX_ENV: py27
+
+checkout:
+    post:
+        - git submodule update --init
+        - pip install -U pip setuptools virtualenv
+
+dependencies:
+    pre:
+        - pip install tox
+
+test:
+    override:
+        - tox -e $TOX_ENV

docs/articles.rst

@@ -1,16 +1,50 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _articles:
 
 Articles about us
 =================
 
 .. note::
-	If you've writeen article about PlatformIO and would like it listed on
-	this page, `please edit this page <https://github.com/platformio/platformio/blob/develop/docs/articles.rst>`_.
+    If you've written article about PlatformIO and would like it listed on
+    this page, `please edit this page <https://github.com/platformio/platformio/blob/develop/docs/articles.rst>`_.
 
 Here are recent articles about PlatformIO:
 
+2015
+^^^^
+
+* Nov 09, 2015 - **ÁLvaro García Gómez** - `Programar con Arduino "The good way" (Programming with Arduino "The good way", Spanish) <http://congdegnu.es/2015/11/09/programar-con-arduino-the-good-way/>`_
+* Nov 06, 2015 - **nocd5** - `PlatformIOでmbedをオフラインビルドしSTM32 Nucleoボードでmrubyを使う (Use mruby in the offline build for STM32 Nucleo board with mbed and PlatformIO, Japanese) <http://qiita.com/nocd5/items/d5fda776240f7e7c17eb>`_
+* Oct 18, 2015 - **Nico Coetzee** - `First Arduino I2C Experience with PlatformIO <https://electronicventurer.wordpress.com/2015/10/18/first-arduino-i2c-experience/>`_
+* Sep 01, 2015 - **Thomas P. Weldon, Ph.D.** - `Improvised MBED FRDM-K64F Eclipse/PlatformIO Setup and Software Installation <http://thomasweldon.com/tpw/courses/embeddsp/p00pcFrdmK64_eclipsePlatformioSetup.html>`_
+* Aug 01, 2015 - **Russell Davis** - `PlatformIO on the Raspberry Pi <http://www.russelldavis.org/2015/08/01/platformio-on-the-raspberry-pi/>`_
+* Jul 25, 2015 - **DinoTools** - `Erste Schritte mit PlatformIO (Getting Started with PlatformIO, German) <https://www.dinotools.de/2015/07/25/erste-schritte-mit-platformio/>`_
+* Jul 20, 2015 - **Eli Fatsi** - `Arduino Development in Atom Editor <http://viget.com/extend/arduino-development-in-atom-editor>`_
+* Jul 14, 2015 - **ElbinarIO** - `Programar para Arduino y otros microcontroladores desde la linea de comandos (Program Arguino and other microcontrollers from the command line, Spanish) <http://elbinario.net/2015/07/14/programar-para-arduino-y-otros-microcontroladores-desde-la-linea-de-comandos/>`_
+* Jul 11, 2015 - **TrojanC** - `Learning Arduino GitHub Repository <http://www.trojanc.co.za/2015/07/11/learning-arduino-github-repository/>`_
+* Jul 07, 2015 - **Sho Hashimoto** - `PlatformIOでArduino開発する(Arduino development in PlatformIO, Japanese) <http://shokai.org/blog/archives/10250>`_
+* Jun 02, 2015 - **Alejandro Guirao Rodríguez** - `Discovering PlatformIO: The RaspberryPi / Arduino combo kit is a winner option when prototyping an IoT-style project <http://lekum.org/posts/discovering-platformio/index.html>`_
+* May 17, 2015 - **S.S** - `コマンドラインでArduino開発 : vim + platformio (Arduino development at the command line: VIM + PlatformIO, Japanese) <http://qiita.com/caad1229/items/7b5fb47f034ae6e0baf2>`_
+* May 11, 2015 - **IT Hare** - `From Web Developer to Embedded One: Interview with Ivan Kravets, The Guy Behind PlatformIO. Part II <http://ithare.com/from-web-developer-to-embedded-one-interview-with-ivan-kravets-the-guy-behind-platformio-part-ii/>`_
+* May 4, 2015 - **IT Hare** - `From Web Developer to Embedded One: Interview with Ivan Kravets, The Guy Behind PlatformIO. Part I <http://ithare.com/from-web-development-to-embedded-one-interview-with-ivan-kravets-the-guy-behind-platformio-part-i/>`_
+* April 17, 2015 - **Michael Ball** - `PlatformIO - A Cross-Platform Code Builder and Missing Library Manager <http://arduino-pi.blogspot.com.es/2015/04/platformio-cross-platform-code-builder.html>`_
 * March 23, 2015 - **Atmel** - `Cross-board and cross-vendor embedded development with PlatformIO <http://blog.atmel.com/2015/03/23/cross-board-and-cross-vendor-embedded-development-with-platformio/>`_
 * March 22, 2015 - **Mark VandeWettering** - `Discovered a new tool for embedded development: PlatformIO <http://brainwagon.org/2015/03/22/discovered-a-new-tool-for-embedded-development-platformio/>`_
-* October 7, 2014 - **Ivan Kravets** - `Integration of PlatformIO library manager to Arduino and Energia IDEs <http://www.ikravets.com/computer-life/platformio/2014/10/07/integration-of-platformio-library-manager-to-arduino-and-energia-ides>`_
-* June 20, 2014 - **Ivan Kravets** - `Building and debugging Atmel AVR (Arduino-based) project using Eclipse IDE+PlatformIO <http://www.ikravets.com/computer-life/programming/2014/06/20/building-and-debugging-atmel-avr-arduino-based-project-using-eclipse-ideplatformio>`_
-* June 17, 2014 - **Ivan Kravets** - `How was PlatformIO born or why I love Python World <http://www.ikravets.com/computer-life/programming/2014/06/17/how-was-platformio-born-or-why-i-love-python-world>`_
+* February 25, 2015 - **Hendrik Putzek** - `Use your favourite IDE together with Arduino <http://blog.putzek.com/2015/02/your-favourite-ide-with-arduino.html>`_
+
+2014
+^^^^
+
+* October 7, 2014 - **Ivan Kravets, Ph.D.** - `Integration of PlatformIO library manager to Arduino and Energia IDEs <http://www.ikravets.com/computer-life/platformio/2014/10/07/integration-of-platformio-library-manager-to-arduino-and-energia-ides>`_
+* June 20, 2014 - **Ivan Kravets, Ph.D.** - `Building and debugging Atmel AVR (Arduino-based) project using Eclipse IDE+PlatformIO <http://www.ikravets.com/computer-life/programming/2014/06/20/building-and-debugging-atmel-avr-arduino-based-project-using-eclipse-ideplatformio>`_
+* June 17, 2014 - **Ivan Kravets, Ph.D.** - `How was PlatformIO born or why I love Python World <http://www.ikravets.com/computer-life/programming/2014/06/17/how-was-platformio-born-or-why-i-love-python-world>`_

docs/ci/appveyor.rst

@@ -0,0 +1,213 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+.. _ci_appveyor:
+
+AppVeyor
+========
+
+`AppVeyor <http://www.appveyor.com/about>`_ is an open-source hosted,
+distributed continuous integration service used to build and test projects
+hosted at `GitHub <http://en.wikipedia.org/wiki/GitHub>`_ on Windows family
+systems.
+
+AppVeyor is configured by adding a file named ``appveyor.yml``, which is a
+`YAML <http://en.wikipedia.org/wiki/YAML>`_ format text file, to the root
+directory of the GitHub repository.
+
+AppVeyor automatically detects when a commit has been made and pushed to a
+GitHub repository that is using AppVeyor, and each time this happens, it will
+try to build the project using :ref:`cmd_ci` command. This includes commits to
+all branches, not just to the master branch. AppVeyor will also build and run
+pull requests. When that process has completed, it will notify a developer in
+the way it has been configured to do so — for example, by sending an email
+containing the build results (showing success or failure), or by posting a
+message on an IRC channel. It can be configured to build project on a range of
+different :ref:`platforms`.
+
+.. contents::
+
+Integration
+-----------
+
+Put ``appveyor.yml`` to the root directory of the GitHub repository.
+
+.. code-block:: yaml
+
+    build: off
+    environment:
+        global:
+            WITH_COMPILER: "cmd /E:ON /V:ON /C .\\scripts\\appveyor\\run_with_compiler.cmd"
+        matrix:
+            - PLATFORMIO_CI_SRC: "path\\to\\source\\file.c"
+              PLATFORMIO_CI_SRC: "path\\to\\source\\file.ino"
+              PLATFORMIO_CI_SRC: "path\\to\\source\\directory"
+              WINDOWS_SDK_VERSION: "v7.0"
+              PYTHON_HOME: "C:\\Python27-x64"
+              PYTHON_VERSION: "2.7"
+              PYTHON_ARCH: "64"
+        install:
+          - "git submodule update --init --recursive"
+          - "powershell scripts\\appveyor\\install.ps1"
+        before_test:
+          - cmd: SET PATH=%PATH%;%PYTHON_HOME%;%PYTHON_HOME%\Scripts
+        test_script:
+          - '%WITH_COMPILER% %PYTHON_HOME%\\Scripts\\platformio ci --board=TYPE_1 --board=TYPE_2 --board=TYPE_N'
+
+
+Then create ``scripts/appveyor`` folder and put these 2 scripts (they are the
+same for the all projects, don't need to modify them):
+
+1. ``scripts/appveyor/install.ps1``:
+
+.. code-block:: PowerShell
+
+    $BASE_URL = "https://www.python.org/ftp/python/"
+    $GET_PIP_URL = "https://bootstrap.pypa.io/get-pip.py"
+    $GET_PIP_PATH = "C:\get-pip.py"
+
+
+    function DownloadPython ($python_version, $platform_suffix) {
+        $webclient = New-Object System.Net.WebClient
+        $filename = "python-" + $python_version + $platform_suffix + ".msi"
+        $url = $BASE_URL + $python_version + "/" + $filename
+
+        $basedir = $pwd.Path + "\"
+        $filepath = $basedir + $filename
+        if (Test-Path $filename) {
+            Write-Host "Reusing" $filepath
+            return $filepath
+        }
+
+        # Download and retry up to 5 times in case of network transient errors.
+        Write-Host "Downloading" $filename "from" $url
+        $retry_attempts = 3
+        for($i=0; $i -lt $retry_attempts; $i++){
+            try {
+                $webclient.DownloadFile($url, $filepath)
+                break
+            }
+            Catch [Exception]{
+                Start-Sleep 1
+            }
+       }
+       Write-Host "File saved at" $filepath
+       return $filepath
+    }
+
+
+    function InstallPython ($python_version, $architecture, $python_home) {
+        Write-Host "Installing Python" $python_version "for" $architecture "bit architecture to" $python_home
+        if (Test-Path $python_home) {
+            Write-Host $python_home "already exists, skipping."
+            return $false
+        }
+        if ($architecture -eq "32") {
+            $platform_suffix = ""
+        } else {
+            $platform_suffix = ".amd64"
+        }
+        $filepath = DownloadPython $python_version $platform_suffix
+        Write-Host "Installing" $filepath "to" $python_home
+        $args = "/qn /i $filepath TARGETDIR=$python_home"
+        Write-Host "msiexec.exe" $args
+        Start-Process -FilePath "msiexec.exe" -ArgumentList $args -Wait -Passthru
+        Write-Host "Python $python_version ($architecture) installation complete"
+        return $true
+    }
+
+
+    function InstallPip ($python_home) {
+        $python_path = $python_home + "/python.exe"
+        Write-Host "Installing pip..."
+        $webclient = New-Object System.Net.WebClient
+        $webclient.DownloadFile($GET_PIP_URL, $GET_PIP_PATH)
+        Write-Host "Executing:" $python_path $GET_PIP_PATH
+        Start-Process -FilePath "$python_path" -ArgumentList "$GET_PIP_PATH" -Wait -Passthru
+    }
+
+    function InstallPackage ($python_home, $pkg) {
+        $pip_path = $python_home + "/Scripts/pip.exe"
+        & $pip_path install -U $pkg
+    }
+
+    function main () {
+        InstallPython $env:PYTHON_VERSION $env:PYTHON_ARCH $env:PYTHON_HOME
+        InstallPip $env:PYTHON_HOME
+        InstallPackage $env:PYTHON_HOME setuptools
+        InstallPackage $env:PYTHON_HOME platformio
+    }
+
+    main
+
+2. ``scripts/appveyor/run_with_compiler.cmd``:
+
+.. code-block:: guess
+
+    @ECHO OFF
+
+    SET COMMAND_TO_RUN=%*
+    SET WIN_SDK_ROOT=C:\Program Files\Microsoft SDKs\Windows
+
+    SET MAJOR_PYTHON_VERSION="%PYTHON_VERSION:~0,1%"
+    IF %MAJOR_PYTHON_VERSION% == "2" (
+        SET WINDOWS_SDK_VERSION="v7.0"
+    ) ELSE IF %MAJOR_PYTHON_VERSION% == "3" (
+        SET WINDOWS_SDK_VERSION="v7.1"
+    ) ELSE (
+        ECHO Unsupported Python version: "%MAJOR_PYTHON_VERSION%"
+        EXIT 1
+    )
+
+    IF "%PYTHON_ARCH%"=="64" (
+        ECHO Configuring Windows SDK %WINDOWS_SDK_VERSION% for Python %MAJOR_PYTHON_VERSION% on a 64 bit architecture
+        SET DISTUTILS_USE_SDK=1
+        SET MSSdk=1
+        "%WIN_SDK_ROOT%\%WINDOWS_SDK_VERSION%\Setup\WindowsSdkVer.exe" -q -version:%WINDOWS_SDK_VERSION%
+        "%WIN_SDK_ROOT%\%WINDOWS_SDK_VERSION%\Bin\SetEnv.cmd" /x64 /release
+        ECHO Executing: %COMMAND_TO_RUN%
+        call %COMMAND_TO_RUN% || EXIT 1
+    ) ELSE (
+        ECHO Using default MSVC build environment for 32 bit architecture
+        ECHO Executing: %COMMAND_TO_RUN%
+        call %COMMAND_TO_RUN% || EXIT 1
+    )
+
+For more details as for PlatformIO build process please look into :ref:`cmd_ci`
+command.
+
+Examples
+--------
+
+1. Integration for `USB_Host_Shield_2.0 <https://github.com/felis/USB_Host_Shield_2.0>`_
+   project. The ``appveyor.yml`` configuration file:
+
+.. code-block:: yaml
+
+    build: off
+    environment:
+        global:
+            WITH_COMPILER: "cmd /E:ON /V:ON /C .\\scripts\\appveyor\\run_with_compiler.cmd"
+        matrix:
+            - PLATFORMIO_CI_SRC: "examples\\Bluetooth\\PS3SPP\\PS3SPP.ino"
+              PLATFORMIO_CI_SRC: "examples\\pl2303\\pl2303_gps\\pl2303_gps.ino"
+              WINDOWS_SDK_VERSION: "v7.0"
+              PYTHON_HOME: "C:\\Python27-x64"
+              PYTHON_VERSION: "2.7"
+              PYTHON_ARCH: "64"
+        install:
+          - "git submodule update --init --recursive"
+          - "powershell scripts\\appveyor\\install.ps1"
+        before_test:
+          - cmd: SET PATH=%PATH%;%PYTHON_HOME%;%PYTHON_HOME%\Scripts
+          - cmd: git clone https://github.com/xxxajk/spi4teensy3.git c:\spi4teensy
+        test_script:
+          - '%WITH_COMPILER% %PYTHON_HOME%\\Scripts\\platformio ci --lib="." --lib="c:\spi4teensy" --board=uno --board=teensy31 --board=due'

docs/ci/circleci.rst

@@ -0,0 +1,85 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+.. _ci_circleci:
+
+Circle CI
+=========
+
+`Circle CI <https://circleci.com/about>`_ is a hosted cloud
+platform that provides hosted continuous integration, deployment, and testing
+to `GitHub <http://en.wikipedia.org/wiki/GitHub>`_ repositories.
+
+Circle CI is configured by adding a file named ``circle.yml``, which is a
+`YAML <http://en.wikipedia.org/wiki/YAML>`_ format text file, to the root
+directory of the GitHub repository.
+
+Circle CI automatically detects when a commit has been made and pushed to a
+GitHub repository that is using Circle CI, and each time this happens, it will
+try to build the project using :ref:`cmd_ci` command. This includes commits to
+all branches, not just to the master branch. Circle CI will also build and run
+pull requests. When that process has completed, it will notify a developer in
+the way it has been configured to do so — for example, by sending an email
+containing the build results (showing success or failure), or by posting a
+message on an IRC channel. It can be configured to build project on a range of
+different :ref:`platforms`.
+
+.. contents::
+
+Integration
+-----------
+
+Put ``circle.yml`` to the root directory of the GitHub repository.
+
+.. code-block:: yaml
+
+    machine:
+        environment:
+            PLATFORMIO_CI_SRC: path/to/source/file.c
+            PLATFORMIO_CI_SRC: path/to/source/file.ino
+            PLATFORMIO_CI_SRC: path/to/source/directory
+
+    dependencies:
+        pre:
+            - sudo apt-get install python2.7-dev
+            - sudo python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
+
+    test:
+        override:
+            - platformio ci --board=TYPE_1 --board=TYPE_2 --board=TYPE_N
+
+
+For more details as for PlatformIO build process please look into :ref:`cmd_ci`
+command.
+
+Examples
+--------
+
+1. Integration for `USB_Host_Shield_2.0 <https://github.com/felis/USB_Host_Shield_2.0>`_
+   project. The ``circle.yml`` configuration file:
+
+.. code-block:: yaml
+
+    machine:
+        environment:
+            PLATFORMIO_CI_SRC: examples/Bluetooth/PS3SPP/PS3SPP.ino
+            PLATFORMIO_CI_SRC: examples/pl2303/pl2303_gps/pl2303_gps.ino
+
+    dependencies:
+        pre:
+            - sudo apt-get install python2.7-dev
+            - sudo python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
+            - wget https://github.com/xxxajk/spi4teensy3/archive/master.zip -O /tmp/spi4teensy3.zip
+            - unzip /tmp/spi4teensy3.zip -d /tmp
+
+    test:
+        override:
+            - platformio ci --lib="." --lib="/tmp/spi4teensy3-master" --board=uno --board=teensy31 --board=due

docs/ci/drone.rst

@@ -0,0 +1,83 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+.. _ci_drone:
+
+Drone
+=====
+
+`Drone <https://drone.io>`_  is a hosted continuous integration service.
+It enables you to conveniently set up projects to automatically build, test,
+and deploy as you make changes to your code to
+`GitHub <http://en.wikipedia.org/wiki/GitHub>`_ and
+`BitBucket <http://en.wikipedia.org/wiki/Bitbucket>`_ repositories.
+
+Drone is configured by modifying settings in your project control panel.
+
+Drone automatically detects when a commit has been made and pushed to a
+GitHub repository that is using Drone, and each time this happens, it will
+try to build the project using :ref:`cmd_ci` command. This includes commits to
+all branches, not just to the master branch. Drone will also build and run
+pull requests. When that process has completed, it will notify a developer in
+the way it has been configured to do so — for example, by sending an email
+containing the build results (showing success or failure). It can be
+configured to build project on a range of different :ref:`platforms`.
+
+.. contents::
+
+Integration
+-----------
+
+Please fill all fields for your project in the Drone control panel:
+
+`Environment Variables`:
+
+.. code-block:: bash
+
+    PLATFORMIO_CI_SRC=path/to/source/file.c
+    PLATFORMIO_CI_SRC=path/to/source/file.ino
+    PLATFORMIO_CI_SRC=path/to/source/directory
+
+`Commands`:
+
+.. code-block:: bash
+
+    python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
+    platformio ci --board=TYPE_1 --board=TYPE_2 --board=TYPE_N
+
+.. image:: ../_static/droneci-platformio-integration-1.png
+
+For more details as for PlatformIO build process please look into :ref:`cmd_ci`
+command.
+
+Examples
+--------
+
+1. Integration for `USB_Host_Shield_2.0 <https://github.com/felis/USB_Host_Shield_2.0>`_
+   project. The ``circle.yml`` configuration file:
+
+`Environment Variables`:
+
+.. code-block:: bash
+
+    PLATFORMIO_CI_SRC=examples/Bluetooth/PS3SPP/PS3SPP.ino
+    PLATFORMIO_CI_SRC=examples/pl2303/pl2303_gps/pl2303_gps.ino
+
+`Commands`:
+
+.. code-block:: bash
+
+    python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
+    wget https://github.com/xxxajk/spi4teensy3/archive/master.zip -O /tmp/spi4teensy3.zip
+    unzip /tmp/spi4teensy3.zip -d /tmp
+    platformio ci --lib="." --lib="/tmp/spi4teensy3-master" --board=uno --board=teensy31 --board=due
+
+.. image:: ../_static/droneci-platformio-integration-2.png

docs/ci/index.rst

@@ -0,0 +1,35 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+.. _ci:
+
+Continuous Integration
+======================
+
+`Continuous Integration (CI, wiki) <http://en.wikipedia.org/wiki/Continuous_integration>`_
+is the practice, in software engineering, of merging all developer working
+copies with a shared mainline several times a day.
+
+:ref:`cmd_ci` command is intended to be used in combination with the build
+servers and the popular
+`Continuous Integration Software <http://en.wikipedia.org/wiki/Comparison_of_continuous_integration_software>`_.
+
+By integrating regularly, you can detect errors quickly, and locate them more
+easily.
+
+.. toctree::
+    :maxdepth: 2
+
+    appveyor
+    circleci
+    drone
+    shippable
+    travis

docs/ci/shippable.rst

@@ -0,0 +1,89 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+.. _ci_shippable:
+
+Shippable
+=========
+
+`Shippable <http://en.wikipedia.org/wiki/Shippable>`_ is a hosted cloud
+platform that provides hosted continuous integration, deployment, and testing
+to `GitHub <http://en.wikipedia.org/wiki/GitHub>`_ and
+`BitBucket <http://en.wikipedia.org/wiki/Bitbucket>`_ repositories.
+Shippable's continuous integration service is built using Docker.
+
+Shippable is configured by adding a file named ``shippable.yml``, which is a
+`YAML <http://en.wikipedia.org/wiki/YAML>`_ format text file, to the root
+directory of the GitHub repository or you can use your Travis CI configuration
+file ``.travis.yml``.
+
+Shippable automatically detects when a commit has been made and pushed to a
+GitHub repository that is using Shippable, and each time this happens, it will
+try to build the project using :ref:`cmd_ci` command. This includes commits to
+all branches, not just to the master branch. Shippable will also build and run
+pull requests. When that process has completed, it will notify a developer in
+the way it has been configured to do so — for example, by sending an email
+containing the build results (showing success or failure), or by posting a
+message on an IRC channel. It can be configured to build project on a range of
+different :ref:`platforms`.
+
+.. contents::
+
+Integration
+-----------
+
+Please put ``shippable.yml`` or ``.travis.yml`` to the root directory of the
+GitHub repository.
+
+.. code-block:: yaml
+
+    language: python
+    python:
+        - "2.7"
+
+    env:
+        - PLATFORMIO_CI_SRC=path/to/source/file.c
+        - PLATFORMIO_CI_SRC=path/to/source/file.ino
+        - PLATFORMIO_CI_SRC=path/to/source/directory
+
+    install:
+        - python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
+
+    script:
+        - platformio ci --board=TYPE_1 --board=TYPE_2 --board=TYPE_N
+
+
+For more details as for PlatformIO build process please look into :ref:`cmd_ci`
+command.
+
+Examples
+--------
+
+1. Integration for `USB_Host_Shield_2.0 <https://github.com/felis/USB_Host_Shield_2.0>`_
+   project. The ``shippable.yml`` or ``.travis.yml`` configuration file:
+
+.. code-block:: yaml
+
+    language: python
+    python:
+        - "2.7"
+
+    env:
+        - PLATFORMIO_CI_SRC=examples/Bluetooth/PS3SPP/PS3SPP.ino
+        - PLATFORMIO_CI_SRC=examples/pl2303/pl2303_gps/pl2303_gps.ino
+
+    install:
+        - python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
+        - wget https://github.com/xxxajk/spi4teensy3/archive/master.zip -O /tmp/spi4teensy3.zip
+        - unzip /tmp/spi4teensy3.zip -d /tmp
+
+    script:
+        - platformio ci --lib="." --lib="/tmp/spi4teensy3-master" --board=uno --board=teensy31 --board=due

docs/ci/travis.rst

@@ -0,0 +1,263 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+.. _ci_travis:
+
+Travis CI
+=========
+
+`Travis CI <http://en.wikipedia.org/wiki/Travis_CI>`_ is an open-source hosted,
+distributed continuous integration service used to build and test projects
+hosted at `GitHub <http://en.wikipedia.org/wiki/GitHub>`_.
+
+Travis CI is configured by adding a file named ``.travis.yml``, which is a
+`YAML <http://en.wikipedia.org/wiki/YAML>`_ format text file, to the root
+directory of the GitHub repository.
+
+Travis CI automatically detects when a commit has been made and pushed to a
+GitHub repository that is using Travis CI, and each time this happens, it will
+try to build the project using :ref:`cmd_ci` command. This includes commits to
+all branches, not just to the master branch. Travis CI will also build and run
+pull requests. When that process has completed, it will notify a developer in
+the way it has been configured to do so — for example, by sending an email
+containing the build results (showing success or failure), or by posting a
+message on an IRC channel. It can be configured to build project on a range of
+different :ref:`platforms`.
+
+.. contents::
+
+Integration
+-----------
+
+Please make sure to read Travis CI `Getting Started <http://docs.travis-ci.com/user/getting-started/>`_
+and `general build configuration <http://docs.travis-ci.com/user/customizing-the-build/>`_
+guides first.
+
+PlatformIO is written in Python and is recommended to be run within
+`Travis CI Python isolated environment <http://docs.travis-ci.com/user/languages/python/#Travis-CI-Uses-Isolated-virtualenvs>`_:
+
+.. code-block:: yaml
+
+    language: python
+    python:
+        - "2.7"
+
+    # Cache PlatformIO packages using Travis CI container-based infrastructure
+    sudo: false
+    cache:
+        directories:
+            - "~/.platformio"
+
+    env:
+        - PLATFORMIO_CI_SRC=path/to/test/file.c
+        - PLATFORMIO_CI_SRC=examples/file.ino
+        - PLATFORMIO_CI_SRC=path/to/test/directory
+
+    install:
+        - pip install -U platformio
+
+    script:
+        - platformio ci --board=TYPE_1 --board=TYPE_2 --board=TYPE_N
+
+Then perform steps 1, 2 and 4 from http://docs.travis-ci.com/user/getting-started/
+
+For more details as for PlatformIO build process please look into :ref:`cmd_ci`.
+
+Project as a library
+~~~~~~~~~~~~~~~~~~~~
+
+When project is written as a library (where own examples or testing code use
+it), please use ``--lib="."`` option for :ref:`cmd_ci` command
+
+.. code-block:: yaml
+
+    script:
+        - platformio ci --lib="." --board=TYPE_1 --board=TYPE_2 --board=TYPE_N
+
+Library dependecies
+~~~~~~~~~~~~~~~~~~~
+
+There 2 options to test source code with dependent libraries:
+
+Install dependent library using :ref:`librarymanager`
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: yaml
+
+    install:
+        - pip install -U platformio
+
+        #
+        # Libraries from PlatformIO Library Registry:
+        #
+        # http://platformio.org/#!/lib/show/1/OneWire
+        platformio lib install 1
+
+Manually download dependent library and include in build process via ``--lib`` option
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: yaml
+
+    install:
+        - pip install -U platformio
+
+        # download library to the temporary directory
+        wget https://github.com/PaulStoffregen/OneWire/archive/master.zip -O /tmp/onewire_source.zip
+        unzip /tmp/onewire_source.zip -d /tmp/
+
+    script:
+        - platformio ci --lib="/tmp/OneWire-master" --board=TYPE_1 --board=TYPE_2 --board=TYPE_N
+
+Custom Build Flags
+~~~~~~~~~~~~~~~~~~
+
+PlatformIO allows to specify own build flags using :envvar:`PLATFORMIO_BUILD_FLAGS` environment
+
+.. code-block:: yaml
+
+    env:
+        - PLATFORMIO_CI_SRC=path/to/test/file.c PLATFORMIO_BUILD_FLAGS="-D SPECIFIC_MACROS_PER_TEST_ENV -I/extra/inc"
+        - PLATFORMIO_CI_SRC=examples/file.ino
+        - PLATFORMIO_CI_SRC=path/to/test/directory
+
+    install:
+        - pip install -U platformio
+
+        export PLATFORMIO_BUILD_FLAGS=-D GLOBAL_MACROS_FOR_ALL_TEST_ENV
+
+
+For the more details, please follow to
+:ref:`available build flags/options <projectconf_build_flags>`.
+
+
+Advanced configuration
+~~~~~~~~~~~~~~~~~~~~~~
+
+PlatformIO allows to configure multiple build environments for the single
+source code using :ref:`projectconf`.
+
+Instead of ``--board`` option, please use :option:`platformio ci --project-conf`
+
+.. code-block:: yaml
+
+    script:
+        - platformio ci --project-conf=/path/to/platoformio.ini
+
+Examples
+--------
+
+1. Custom build flags
+
+.. code-block:: yaml
+
+    language: python
+    python:
+        - "2.7"
+
+    # Cache PlatformIO packages using Travis CI container-based infrastructure
+    sudo: false
+    cache:
+        directories:
+            - "~/.platformio"
+
+    env:
+        - PLATFORMIO_CI_SRC=examples/acm/acm_terminal
+        - PLATFORMIO_CI_SRC=examples/Bluetooth/WiiIRCamera PLATFORMIO_BUILD_FLAGS="-DWIICAMERA"
+        - PLATFORMIO_CI_SRC=examples/ftdi/USBFTDILoopback
+        - PLATFORMIO_CI_SRC=examples/Xbox/XBOXUSB
+        # - ...
+
+    install:
+        - pip install -U platformio
+
+        #
+        # Libraries from PlatformIO Library Registry:
+        #
+        # http://platformio.org/#!/lib/show/416/TinyGPS
+        # http://platformio.org/#!/lib/show/417/SPI4Teensy3
+        - platformio lib install 416 417
+
+    script:
+        - platformio ci --board=uno --board=teensy31 --board=due --lib="."
+
+* Configuration file: https://github.com/felis/USB_Host_Shield_2.0/blob/master/.travis.yml
+* Build History: https://travis-ci.org/felis/USB_Host_Shield_2.0
+
+2. Dependency on external libraries
+
+.. code-block:: yaml
+
+    language: python
+    python:
+        - "2.7"
+
+    # Cache PlatformIO packages using Travis CI container-based infrastructure
+    sudo: false
+    cache:
+        directories:
+            - "~/.platformio"
+
+    env:
+        - PLATFORMIO_CI_SRC=examples/backSoon/backSoon.ino
+        - PLATFORMIO_CI_SRC=examples/etherNode/etherNode.ino
+        # -
+
+    install:
+        - pip install -U platformio
+
+        - wget https://github.com/jcw/jeelib/archive/master.zip -O /tmp/jeelib.zip
+        - unzip /tmp/jeelib.zip -d /tmp
+
+        - wget https://github.com/Rodot/Gamebuino/archive/master.zip  -O /tmp/gamebuino.zip
+        - unzip /tmp/gamebuino.zip -d /tmp
+
+    script:
+        - platformio ci --lib="." --lib="/tmp/jeelib-master" --lib="/tmp/Gamebuino-master/libraries/tinyFAT" --board=uno --board=megaatmega2560
+
+* Configuration file: https://github.com/jcw/ethercard/blob/master/.travis.yml
+* Build History: https://travis-ci.org/jcw/ethercard
+
+3. Dynamic testing of the boards
+
+.. code-block:: yaml
+
+    language: python
+    python:
+        - "2.7"
+
+    # Cache PlatformIO packages using Travis CI container-based infrastructure
+    sudo: false
+    cache:
+        directories:
+            - "~/.platformio"
+
+    env:
+        - PLATFORMIO_CI_SRC=examples/TimeArduinoDue PLATFORMIO_CI_BOARDS_ARGS="--board=due"
+        - PLATFORMIO_CI_SRC=examples/TimeGPS
+        - PLATFORMIO_CI_SRC=examples/TimeNTP
+        - PLATFORMIO_CI_SRC=examples/TimeTeensy3 PLATFORMIO_CI_BOARDS_ARGS="--board=teensy31"
+        # - ...
+
+    install:
+        - pip install -U platformio
+        - rm -rf ./linux
+
+        #
+        # Libraries from PlatformIO Library Registry:
+        #
+        # http://platformio.org/#!/lib/show/416/TinyGPS
+        - platformio lib install 416 421 422
+
+    script:
+        - if [[ $PLATFORMIO_CI_BOARDS_ARGS ]]; then bash -c 'platformio ci --lib="." $PLATFORMIO_CI_BOARDS_ARGS'; else bash -c 'platformio ci --lib="." --board=uno --board=teensy20pp'; fi
+
+* Configuration file: https://github.com/ivankravets/Time/blob/master/.travis.yml
+* Build History: https://travis-ci.org/ivankravets/Time

docs/demo.rst

@@ -0,0 +1,61 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+.. _demo:
+
+Demo
+====
+
+.. contents::
+
+Wiring Blink
+------------
+
+.. image:: _static/platformio-demo-wiring.gif
+
+Used in demo
+~~~~~~~~~~~~
+
+1. Source code of `Wiring Blink Example <https://github.com/platformio/platformio/tree/develop/examples/wiring-blink>`_
+2. :ref:`cmd_run` command
+3. :ref:`platformio run -t upload <cmd_run>` command.
+
+Platform Manager
+----------------
+
+.. image:: _static/platformio-demo-platforms.gif
+
+Used in demo
+~~~~~~~~~~~~
+
+1. :ref:`userguide_platforms`
+2. :ref:`cmd_platforms_list` command
+3. :ref:`platformio platforms search avr <cmd_platforms_search>` command
+4. :ref:`platformio platforms show teensy <cmd_platforms_show>` command
+5. :ref:`cmd_platforms_update` command.
+
+Library Manager
+---------------
+
+.. image:: _static/platformio-demo-lib.gif
+
+Used in demo
+~~~~~~~~~~~~
+
+1. :ref:`userguide_lib`
+2. :ref:`platformio lib search 1-wire <cmd_lib_search>` command
+3. :ref:`platformio lib install 54 <cmd_lib_install>` command
+4. :ref:`platformio lib search -f mbed <cmd_lib_search>` command
+5. :ref:`platformio lib search -k rf <cmd_lib_search>` command
+6. :ref:`platformio lib search radiohead <cmd_lib_search>` command
+7. :ref:`platformio lib install 124 --version "1.40" <cmd_lib_install>` command
+8. :ref:`platformio lib show 124 <cmd_lib_show>` command
+9. :ref:`cmd_lib_update` command.

docs/envvars.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _envvars:
 
 Environment variables
@@ -18,10 +29,7 @@ General
 PlatformIO uses *General* environment variables for the common
 operations/commands.
 
-.. _envvar_CI:
-
-CI
-~~
+.. envvar:: CI
 
 PlatformIO handles ``CI`` variable which is setup by
 `Continuous Integration <http://en.wikipedia.org/wiki/Continuous_integration>`_
@@ -29,51 +37,44 @@ PlatformIO handles ``CI`` variable which is setup by
 Currently, PlatformIO uses it to disable prompts.
 
 In other words, ``CI=true`` automatically setup
-:ref:`PLATFORMIO_SETTING_ENABLE_PROMPTS=false <envvar_PLATFORMIO_SETTING_ENABLE_PROMPTS>`.
+:envvar:`PLATFORMIO_SETTING_ENABLE_PROMPTS=false <PLATFORMIO_SETTING_ENABLE_PROMPTS>`.
 
-.. _envvar_PLATFORMIO_HOME_DIR:
+.. envvar:: PLATFORMIO_HOME_DIR
 
-PLATFORMIO_HOME_DIR
-~~~~~~~~~~~~~~~~~~~
+Allows to override :ref:`projectconf` option :ref:`projectconf_pio_home_dir`.
 
-Allows to override :ref:`projectconf` option
-:ref:`projectconf_pio_home_dir`.
+.. envvar:: PLATFORMIO_LIB_DIR
 
-.. _envvar_PLATFORMIO_LIB_DIR:
+Allows to override :ref:`projectconf` option :ref:`projectconf_pio_lib_dir`.
 
-PLATFORMIO_LIB_DIR
-~~~~~~~~~~~~~~~~~~
+.. envvar:: PLATFORMIO_SRC_DIR
 
-Allows to override :ref:`projectconf` option
-:ref:`projectconf_pio_lib_dir`.
+Allows to override :ref:`projectconf` option :ref:`projectconf_pio_src_dir`.
 
-.. _envvar_PLATFORMIO_SRC_DIR:
+.. envvar:: PLATFORMIO_ENVS_DIR
 
-PLATFORMIO_SRC_DIR
-~~~~~~~~~~~~~~~~~~
-
-Allows to override :ref:`projectconf` option
-:ref:`projectconf_pio_src_dir`.
-
-.. _envvar_PLATFORMIO_ENVS_DIR:
-
-PLATFORMIO_ENVS_DIR
-~~~~~~~~~~~~~~~~~~~
-
-Allows to override :ref:`projectconf` option
-:ref:`projectconf_pio_envs_dir`.
+Allows to override :ref:`projectconf` option :ref:`projectconf_pio_envs_dir`.
 
 
 Builder
 -------
 
-.. _envvar_PLATFORMIO_SRCBUILD_FLAGS:
+.. envvar:: PLATFORMIO_BUILD_FLAGS
 
-PLATFORMIO_SRCBUILD_FLAGS
-~~~~~~~~~~~~~~~~~~~~~~~~~
+Allows to set :ref:`projectconf` option :ref:`projectconf_build_flags`.
+
+.. envvar:: PLATFORMIO_SRC_BUILD_FLAGS
+
+Allows to set :ref:`projectconf` option :ref:`projectconf_src_build_flags`.
+
+.. envvar:: PLATFORMIO_SRC_FILTER
+
+Allows to set :ref:`projectconf` option :ref:`projectconf_src_filter`.
+
+.. envvar:: PLATFORMIO_EXTRA_SCRIPT
+
+Allows to set :ref:`projectconf` option :ref:`projectconf_extra_script`.
 
-Allows to override :ref:`projectconf` option
-:ref:`projectconf_srcbuild_flags`.
 
 Settings
 --------
@@ -81,40 +82,30 @@ Settings
 Allows to override PlatformIO settings. You can manage them via
 :ref:`cmd_settings` command.
 
-
-PLATFORMIO_SETTING_AUTO_UPDATE_LIBRARIES
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. envvar:: PLATFORMIO_SETTING_AUTO_UPDATE_LIBRARIES
 
 Allows to override setting :ref:`setting_auto_update_libraries`.
 
-PLATFORMIO_SETTING_AUTO_UPDATE_PLATFORMS
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. envvar:: PLATFORMIO_SETTING_AUTO_UPDATE_PLATFORMS
 
 Allows to override setting :ref:`setting_auto_update_platforms`.
 
-PLATFORMIO_SETTING_CHECK_LIBRARIES_INTERVAL
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. envvar:: PLATFORMIO_SETTING_CHECK_LIBRARIES_INTERVAL
 
 Allows to override setting :ref:`setting_check_libraries_interval`.
 
-PLATFORMIO_SETTING_CHECK_PLATFORMIO_INTERVAL
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. envvar:: PLATFORMIO_SETTING_CHECK_PLATFORMIO_INTERVAL
 
 Allows to override setting :ref:`setting_check_platformio_interval`.
 
-PLATFORMIO_SETTING_CHECK_PLATFORMS_INTERVAL
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. envvar:: PLATFORMIO_SETTING_CHECK_PLATFORMS_INTERVAL
 
 Allows to override setting :ref:`setting_check_platforms_interval`.
 
-.. _envvar_PLATFORMIO_SETTING_ENABLE_PROMPTS:
-
-PLATFORMIO_SETTING_ENABLE_PROMPTS
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. envvar:: PLATFORMIO_SETTING_ENABLE_PROMPTS
 
 Allows to override setting :ref:`setting_enable_prompts`.
 
-PLATFORMIO_SETTING_ENABLE_TELEMETRY
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. envvar:: PLATFORMIO_SETTING_ENABLE_TELEMETRY
 
 Allows to override setting :ref:`setting_enable_telemetry`.

docs/faq.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _faq:
 
 Frequently Asked Questions
@@ -13,8 +24,8 @@ General
 What is PlatformIO?
 ~~~~~~~~~~~~~~~~~~~
 
-`PlatformIO <http://platformio.org>`_ is a cross-platform code builder
-and the missing library manager.
+`PlatformIO <http://platformio.org>`_ is an open-source cross-platform code
+builder and the missing library manager.
 
 PlatformIO is independent from the platform, in which it is running. In fact,
 the only requirement is Python, which exists pretty much everywhere. What this
@@ -24,13 +35,14 @@ between team members, regardless of operating system they prefer to work with.
 Beyond that, PlatformIO can be run not only on commonly used desktops/laptops
 but also on the servers without X Window System. While PlatformIO itself is a
 console application, it can be used in combination with one's favorite
-:ref:`ide` or text editor such as :ref:`ide_arduino`, :ref:`ide_eclipse`,
-:ref:`ide_visualstudio`, :ref:`ide_vim`,  :ref:`ide_sublimetext`, etc.
+:ref:`ide` or text editor such as :ref:`ide_arduino`, :ref:`ide_atom`,
+:ref:`ide_clion`, :ref:`ide_eclipse`, :ref:`ide_qtcreator`,
+:ref:`ide_sublimetext`, :ref:`ide_vim`, :ref:`ide_visualstudio`, etc.
 
 Alright, so PlatformIO can run on different operating systems. But more
 importantly, from development perspective at least, is a list of supported
-boards and MCUs. To keep things short: PlatformIO supports over 100
-:ref:`Embedded Boards <platforms>` and all major
+boards and MCUs. To keep things short: PlatformIO supports over 150+
+`Embedded Boards <http://platformio.org/#!/boards>`_ and all major
 :ref:`Development Platforms <platforms>`.
 
 PlatformIO allows users to:
@@ -55,11 +67,71 @@ the project developed using PlatformIO is as follows:
 * Users develop code and PlatformIO makes sure that it is compiled, prepared
   and uploaded to all the boards of interest.
 
+Command completion in Terminal
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Bash completion
+'''''''''''''''
+
+Bash completion support will complete subcommands and parameters. To enable
+Bash completion for `platformio` subcommands you need to put into your `.bashrc`:
+
+.. code-block:: bash
+
+    eval "$(_PLATFORMIO_COMPLETE=source platformio)"
+
+ZSH completion
+''''''''''''''
+
+To enable ``zsh`` completion please run these commands:
+
+.. code-block:: bash
+
+    autoload bashcompinit && bashcompinit
+    eval "$(_PLATFORMIO_COMPLETE=source platformio)"
+
+.. note::
+
+    For permanent command completion you need to place commands above to
+    ``~/.bashrc`` or ``~/.zshrc`` file.
+
 .. _faq_troubleshooting:
 
 Troubleshooting
 ---------------
 
+Installation
+~~~~~~~~~~~~
+
+PlatformIO and SCons aren't installed properly
+''''''''''''''''''''''''''''''''''''''''''''''
+
+Try these solutions:
+
+1. Upgrade SCons via `pip <https://pip.pypa.io>`_
+
+.. code-block:: bash
+
+    [sudo] pip uninstall scons
+    [sudo] pip install scons
+
+    # or if you have "error: option --single-version-externally-managed not recognized"
+    [sudo] pip install --egg scons
+
+2. Install PlatformIO using :ref:`installation_installer_script`.
+
+.. _faq_troubleshooting_sconssingverextmanaged:
+
+PIP & SCons Error: option --single-version-externally-managed not recognized
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+
+Answered in `issue #279 <https://github.com/platformio/platformio/issues/279>`_.
+
+[Errno 1] Operation not permitted
+'''''''''''''''''''''''''''''''''
+
+Answered in `issue #295 <https://github.com/platformio/platformio/issues/295#issuecomment-143772005>`_.
+
 .. _faq_troubleshooting_pioblocksprompt:
 
 PlatformIO blocks command execution using user prompt
@@ -69,14 +141,39 @@ If you are going to run *PlatformIO* from **subprocess**, you **MUST
 DISABLE** all prompts. It will allow you to avoid blocking.
 There are a few options:
 
-- using environment variable :ref:`PLATFORMIO_SETTING_ENABLE_PROMPTS=No <envvar_PLATFORMIO_SETTING_ENABLE_PROMPTS>`
+- using :option:`platformio --force` option before each command
+- using environment variable :envvar:`PLATFORMIO_SETTING_ENABLE_PROMPTS=No <PLATFORMIO_SETTING_ENABLE_PROMPTS>`
 - disable global setting ``enable_prompts`` via :ref:`cmd_settings` command
 - masking under Continuous Integration system via environment variable
-  :ref:`CI=true <envvar_CI>`.
+  :envvar:`CI=true <CI>`.
 
+.. _faq_troubleshooting_pionotfoundinpath:
 
-Windows: ``UnicodeDecodeError: 'ascii' codec can't decode byte``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Program ``platformio`` not found in PATH
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Where is ``platformio`` binary installed? Run this command in Terminal
+
+.. code-block:: bash
+
+    # for Unix
+    which platformio
+    echo $PATH
+
+    # for Windows OS
+    where platformio
+    echo %PATH%
+
+For example, ``which platformio`` is equal to ``/usr/local/bin/platformio``,
+then `PATH (wiki) <https://en.wikipedia.org/wiki/PATH_(variable)>`_
+should contain ``/usr/local/bin`` directory.
+
+**Unix Users**: You can make "symlinks" from ``platformio`` and ``scons``
+programs to the ``bin`` directory which is included in ``$PATH``. For example,
+see `issue #272 <https://github.com/platformio/platformio/issues/272#issuecomment-133626112>`_.
+
+Windows UnicodeDecodeError: 'ascii' codec can't decode byte
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Answered in `issue #143 <https://github.com/platformio/platformio/issues/143#issuecomment-88060906>`_.
 
@@ -86,16 +183,32 @@ Serial does not work with panStampAVR board
 Answered in `issue #144 <https://github.com/platformio/platformio/issues/144#issuecomment-87388038>`_.
 
 
-An error ``pkg_resources.DistributionNotFound``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+PlatformIO: command not found || An error ``pkg_resources.DistributionNotFound``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Please upgrade *SetupTools* package:
 
 .. code-block:: bash
 
-    $ [sudo] pip uninstall setuptools
-    $ [sudo] pip install setuptools
+    [sudo] pip uninstall setuptools
+    [sudo] pip install setuptools
 
     # Then re-install PlatformIO
-    $ [sudo] pip uninstall platformio
-    $ [sudo] pip install platformio
+    [sudo] pip uninstall platformio
+    [sudo] pip install platformio
+
+Windows AttributeError: 'module' object has no attribute 'packages'
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Answered in `issue #252 <https://github.com/platformio/platformio/issues/252#issuecomment-127072039>`_.
+
+ARM toolchain: cc1plus: error while loading shared libraries
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+See related answers for
+`error while loading shared libraries <https://github.com/platformio/platformio/issues?utf8=✓&q=error+while+loading+shared+libraries>`_.
+
+Archlinux: libncurses.so.5: cannot open shared object file
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Answered in `issue #291 <https://github.com/platformio/platformio/issues/291>`_.

docs/frameworks/arduino.rst

@@ -59,6 +59,13 @@ Adafruit
       - 32 Kb
       - 2.5 Kb
 
+    * - ``gemma``
+      - `Adafruit Gemma <http://www.adafruit.com/products/1222>`_
+      - ATTINY85
+      - 8 MHz
+      - 8 Kb
+      - 0.5 Kb
+
     * - ``protrinket3``
       - `Adafruit Pro Trinket 3V/12MHz (USB) <http://www.adafruit.com/products/2010>`_
       - ATMEGA328P
@@ -467,7 +474,14 @@ Espressif
       - RAM
 
     * - ``esp01``
-      - `Espressif ESP8266 board <https://nurdspace.nl/ESP8266>`_
+      - `Espressif ESP8266 ESP-01 board <https://nurdspace.nl/ESP8266>`_
+      - ESP8266
+      - 40 MHz
+      - 512 Kb
+      - 32 Kb
+
+    * - ``esp12e``
+      - `Espressif ESP8266 ESP-12E board (NodeMCU) <https://nurdspace.nl/ESP8266>`_
       - ESP8266
       - 80 MHz
       - 512 Kb
@@ -623,6 +637,26 @@ PanStamp
       - 32 Kb
       - 4 Kb
 
+Punch Through
+~~~~~~~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``lightblue-bean``
+      - `LightBlue Bean <https://punchthrough.com/bean>`_
+      - ATMEGA328P
+      - 8 MHz
+      - 32 Kb
+      - 2 Kb
+
 Quirkbot
 ~~~~~~~~
 
@@ -923,8 +957,8 @@ TinyCircuits
       - 32 Kb
       - 2 Kb
 
-WickedDevice
-~~~~~~~~~~~~
+Wicked Device
+~~~~~~~~~~~~~
 
 .. list-table::
     :header-rows:  1
@@ -937,15 +971,35 @@ WickedDevice
       - RAM
 
     * - ``wildfirev2``
-      - `WickedDevice WildFire v2 [stk500] <http://shop.wickeddevice.com/resources/wildfire/#arduinoidesetup>`_
+      - `Wicked Device WildFire V2 <http://shop.wickeddevice.com/resources/wildfire/>`_
       - ATMEGA1284P
       - 16 MHz
       - 128 Kb
       - 16 Kb
 
     * - ``wildfirev3``
-      - `WickedDevice WildFire v3 [optiboot] <http://shop.wickeddevice.com/resources/wildfire/>`_
+      - `Wicked Device WildFire V3 <http://shop.wickeddevice.com/resources/wildfire/>`_
       - ATMEGA1284P
       - 16 MHz
       - 128 Kb
       - 16 Kb
+
+ubIQio
+~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``ardhat``
+      - `ubIQio Ardhat <http://ardhat.com>`_
+      - ATMEGA328P
+      - 16 MHz
+      - 32 Kb
+      - 2 Kb

docs/frameworks/cmsis.rst

@@ -27,6 +27,40 @@ Boards
       `PlatformIO Boards Explorer <http://platformio.org/#!/boards>`_
     * For more detailed ``board`` information please scroll tables below by horizontal.
 
+Armstrap
+~~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``armstrap_eagle1024``
+      - `Armstrap Eagle 1024 <http://docs.armstrap.org/en/latest/hardware-overview.html>`_
+      - STM32F417VGT6
+      - 168 MHz
+      - 1024 Kb
+      - 192 Kb
+
+    * - ``armstrap_eagle2048``
+      - `Armstrap Eagle 2048 <http://docs.armstrap.org/en/latest/hardware-overview.html>`_
+      - STM32F427VIT6
+      - 168 MHz
+      - 2048 Kb
+      - 256 Kb
+
+    * - ``armstrap_eagle512``
+      - `Armstrap Eagle 512 <http://docs.armstrap.org/en/latest/hardware-overview.html>`_
+      - STM32F407VET6
+      - 168 MHz
+      - 512 Kb
+      - 192 Kb
+
 ST
 ~~
 

docs/frameworks/index.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _frameworks:
 
 Frameworks

docs/frameworks/libopencm3.rst

@@ -64,6 +64,13 @@ ST
       - 128 Kb
       - 16 Kb
 
+    * - ``nucleo_f103rb``
+      - `ST Nucleo F103RB <https://developer.mbed.org/platforms/ST-Nucleo-F103RB/>`_
+      - STM32F103RBT6
+      - 72 MHz
+      - 128 Kb
+      - 20 Kb
+
 TI
 ~~
 

docs/frameworks/mbed.rst

@@ -25,9 +25,15 @@ Platforms
     * - :ref:`platform_nxplpc`
       - The NXP LPC is a family of 32-bit microcontroller integrated circuits by NXP Semiconductors. The LPC chips are grouped into related series that are based around the same 32-bit ARM processor core, such as the Cortex-M4F, Cortex-M3, Cortex-M0+, or Cortex-M0. Internally, each microcontroller consists of the processor core, static RAM memory, flash memory, debugging interface, and various peripherals.
 
+    * - :ref:`platform_siliconlabsefm32`
+      - Silicon Labs EFM32 Gecko 32-bit microcontroller (MCU) family includes devices that offer flash memory configurations up to 256 kB, 32 kB of RAM and CPU speeds up to 48 MHz. Based on the powerful ARM Cortex-M core, the Gecko family features innovative low energy techniques, short wake-up time from energy saving modes and a wide selection of peripherals, making it ideal for battery operated applications and other systems requiring high performance and low-energy consumption.
+
     * - :ref:`platform_ststm32`
       - The STM32 family of 32-bit Flash MCUs based on the ARM Cortex-M processor is designed to offer new degrees of freedom to MCU users. It offers a 32-bit product range that combines very high performance, real-time capabilities, digital signal processing, and low-power, low-voltage operation, while maintaining full integration and ease of development.
 
+    * - :ref:`platform_teensy`
+      - Teensy is a complete USB-based microcontroller development system, in a very small footprint, capable of implementing many types of projects. All programming is done via the USB port. No special programmer is needed, only a standard "Mini-B" USB cable and a PC or Macintosh with a USB port.
+
 Boards
 ------
 
@@ -56,6 +62,26 @@ CQ Publishing
       - 64 Kb
       - 10 Kb
 
+Delta
+~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``dfcm_nnn40``
+      - `Delta DFCM-NNN40 <https://developer.mbed.org/platforms/Delta-DFCM-NNN40/>`_
+      - NRF51822
+      - 32 MHz
+      - 256 Kb
+      - 32 Kb
+
 Embedded Artists
 ~~~~~~~~~~~~~~~~
 
@@ -342,11 +368,11 @@ ST
       - 48 Kb
 
     * - ``disco_f334c8``
-      - `ST 32F3348DISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF260318>`_
+      - `ST 32F3348DISCOVERY <http://www.st.com/web/en/catalog/tools/PF260318>`_
       - STM32F334C8T6
       - 72 MHz
       - 64 Kb
-      - 16 Kb
+      - 12 Kb
 
     * - ``disco_f401vc``
       - `ST 32F401CDISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF259098>`_
@@ -369,6 +395,13 @@ ST
       - 2048 Kb
       - 256 Kb
 
+    * - ``disco_l053c8``
+      - `ST 32L0538DISCOVERY <http://www.st.com/web/en/catalog/tools/PF260319>`_
+      - STM32L053C8T6
+      - 32 MHz
+      - 64 Kb
+      - 8 Kb
+
     * - ``nucleo_f030r8``
       - `ST Nucleo F030R8 <https://developer.mbed.org/platforms/ST-Nucleo-F030R8/>`_
       - STM32F030R8T6
@@ -439,6 +472,13 @@ ST
       - 512 Kb
       - 128 Kb
 
+    * - ``nucleo_f446re``
+      - `ST Nucleo F446RE <https://developer.mbed.org/platforms/ST-Nucleo-F446RE/>`_
+      - STM32F446RET6
+      - 180 MHz
+      - 512 Kb
+      - 128 Kb
+
     * - ``nucleo_l053r8``
       - `ST Nucleo L053R8 <https://developer.mbed.org/platforms/ST-Nucleo-L053R8/>`_
       - STM32L053R8T6
@@ -480,6 +520,54 @@ SeeedStudio
       - 512 Kb
       - 32 Kb
 
+Silicon Labs
+~~~~~~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``efm32gg_stk3700``
+      - `Silicon Labs EFM32GG-STK3700 (Giant Gecko) <https://developer.mbed.org/platforms/EFM32-Giant-Gecko/>`_
+      - EFM32GG990F1024
+      - 48 MHz
+      - 1024 Kb
+      - 128 Kb
+
+    * - ``efm32hg_stk3400``
+      - `Silicon Labs SLSTK3400A USB-enabled (Happy Gecko) <https://developer.mbed.org/platforms/EFM32-Happy-Gecko/>`_
+      - EFM32HG322F64
+      - 24 MHz
+      - 64 Kb
+      - 8 Kb
+
+    * - ``efm32lg_stk3600``
+      - `Silicon Labs EFM32LG-STK3600 (Leopard Gecko) <https://developer.mbed.org/platforms/EFM32-Leopard-Gecko/>`_
+      - EFM32LG990F256
+      - 48 MHz
+      - 256 Kb
+      - 32 Kb
+
+    * - ``efm32wg_stk3800``
+      - `Silicon Labs EFM32WG-STK3800 (Wonder Gecko) <https://developer.mbed.org/platforms/EFM32-Wonder-Gecko/>`_
+      - EFM32WG990F256
+      - 48 MHz
+      - 256 Kb
+      - 32 Kb
+
+    * - ``efm32zg_stk3200``
+      - `Silicon Labs EFM32ZG-STK3200 (Zero Gecko) <https://developer.mbed.org/platforms/EFM32-Zero-Gecko/>`_
+      - EFM2ZG222F32
+      - 24 MHz
+      - 32 Kb
+      - 4 Kb
+
 Solder Splash Labs
 ~~~~~~~~~~~~~~~~~~
 
@@ -527,6 +615,26 @@ Switch Science
       - 32 Kb
       - 4 Kb
 
+Teensy
+~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``teensy31``
+      - `Teensy 3.1 <https://www.pjrc.com/store/teensy31.html>`_
+      - MK20DX256
+      - 72 MHz
+      - 256 Kb
+      - 64 Kb
+
 u-blox
 ~~~~~~
 

docs/frameworks/spl.rst

@@ -27,6 +27,40 @@ Boards
       `PlatformIO Boards Explorer <http://platformio.org/#!/boards>`_
     * For more detailed ``board`` information please scroll tables below by horizontal.
 
+Armstrap
+~~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``armstrap_eagle1024``
+      - `Armstrap Eagle 1024 <http://docs.armstrap.org/en/latest/hardware-overview.html>`_
+      - STM32F417VGT6
+      - 168 MHz
+      - 1024 Kb
+      - 192 Kb
+
+    * - ``armstrap_eagle2048``
+      - `Armstrap Eagle 2048 <http://docs.armstrap.org/en/latest/hardware-overview.html>`_
+      - STM32F427VIT6
+      - 168 MHz
+      - 2048 Kb
+      - 256 Kb
+
+    * - ``armstrap_eagle512``
+      - `Armstrap Eagle 512 <http://docs.armstrap.org/en/latest/hardware-overview.html>`_
+      - STM32F407VET6
+      - 168 MHz
+      - 512 Kb
+      - 192 Kb
+
 ST
 ~~
 

docs/history.rst

@@ -1 +1,12 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. include:: ../HISTORY.rst

docs/ide.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _ide:
 
 IDE Integration
@@ -7,8 +18,11 @@ IDE Integration
     :maxdepth: 2
 
     ide/arduino
+    ide/atom
+    ide/clion
     ide/eclipse
     ide/energia
+    ide/qtcreator
     ide/sublimetext
     ide/vim
     ide/visualstudio

docs/ide/arduino.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _ide_arduino:
 
 Arduino
@@ -23,7 +34,6 @@ Integration
 More detailed information is located in PlatformIO blog:
 `Integration of PlatformIO library manager to Arduino IDE <http://www.ikravets.com/computer-life/platformio/2014/10/07/integration-of-platformio-library-manager-to-arduino-and-energia-ides>`_.
 
-
 Screenshot
 ----------
 

docs/ide/atom.rst

@@ -0,0 +1,50 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+.. _ide_atom:
+
+Atom
+====
+
+`Atom <https://atom.io>`_ is a text editor that's modern, approachable,
+yet hackable to the core—a tool you can customize to do anything but also use
+productively without ever touching a config file.
+
+This software can be used with:
+
+* all available :ref:`platforms`
+* all available :ref:`frameworks`
+
+Refer to the `Atom Documentation <https://atom.io/docs>`_
+page for more detailed information.
+
+.. contents::
+
+Integration
+-----------
+
+Using `Atom Packages <https://atom.io/docs/v1.0.2/using-atom-atom-packages>`_
+please install `platomformio <https://atom.io/packages/platomformio>`_ package.
+
+Screenshot
+----------
+
+Building
+^^^^^^^^
+
+.. image:: ../_static/ide-platformio-atom-1.gif
+    :target: https://atom.io/packages/platomformio
+
+Uploading
+^^^^^^^^^
+
+.. image:: ../_static/ide-platformio-atom-2.gif
+    :target: https://atom.io/packages/platomformio

docs/ide/clion.rst

@@ -0,0 +1,88 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+.. _ide_clion:
+
+CLion
+=====
+
+The `CLion <https://www.jetbrains.com/clion/>`_ is a cross-platform C/C++ IDE
+for Linux, OS X, and Windows integrated with the CMake build system. The
+initial version will support the GCC and Clang compilers and GDB debugger.
+Clion includes such features as a smart editor, code quality assurance,
+automated refactorings, project manager, integrated version control systems.
+
+This software can be used with:
+
+* all available :ref:`platforms`
+* all available :ref:`frameworks`
+
+Refer to the `CDT Documentation <https://www.jetbrains.com/clion/documentation/>`_
+page for more detailed information.
+
+.. contents::
+
+Integration
+-----------
+
+Project Generator
+^^^^^^^^^^^^^^^^^
+
+Since PlatformIO 2.0 you can generate CLion compatible project using
+:option:`platformio init --ide` command. Please choose board type using
+:ref:`cmd_boards` command and run:
+
+.. code-block:: shell
+
+    platformio init --ide clion --board %TYPE%
+
+Then:
+
+1. Import this project via ``Menu: File > Import Project``
+   and specify root directory where is located :ref:`projectconf`
+2. Open source file from ``src`` directory (``*.c, *.cpp, *.ino, etc.``)
+3. Build project: ``Menu: Run > Build``.
+
+There are 3 predefined targets for building:
+
+* ``PLATFORMIO_BUILD`` - build project without auto-uploading
+* ``PLATFORMIO_UPLOAD`` - build and upload (if no errors)
+* ``PLATFORMIO_CLEAN`` - clean compiled objects and etc.
+
+.. warning::
+    PlatformIO generates empty project by default and **code auto-completion
+    will not work!** To enable auto-completion please choose one of:
+
+    * Add source files ``*.c, *.cpp, etc`` to ``src`` directory and re-initialize
+      project with command above
+    * Manually correct ``add_executable`` command in ``CMakeLists.txt`` file
+      (will be created in project directory after initialization).
+
+    ``*.ino`` file isn't acceptable for ``add_executable`` command. You should
+    convert it manually to ``*.cpp``. See `project example <https://github.com/platformio/platformio/tree/develop/examples/ide/clion>`_.
+
+    More info `CLion issue #CPP-3977 <https://youtrack.jetbrains.com/issue/CPP-3977>`_.
+    Active discussion is located in
+    `PlatformIO issue #132 <https://github.com/platformio/platformio/issues/132>`_.
+
+Screenshot
+----------
+
+.. image:: ../_static/ide-platformio-clion.png
+    :target: http://docs.platformio.org/en/latest/_static/ide-platformio-clion.png
+
+Examples
+--------
+
+"Blink" Project
+^^^^^^^^^^^^^^^
+
+Source code of `CLion "Blink" Project <https://github.com/platformio/platformio/tree/develop/examples/ide/clion>`_.

docs/ide/eclipse.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _ide_eclipse:
 
 Eclipse
@@ -15,21 +26,53 @@ registers, and disassembly viewers.
 
 This software can be used with:
 
-* all availalbe :ref:`platforms`
-* all availalbe :ref:`frameworks`
+* all available :ref:`platforms`
+* all available :ref:`frameworks`
 
 Refer to the `CDT Documentation <https://eclipse.org/cdt/documentation.php>`_
 page for more detailed information.
 
+.. contents::
+
 Integration
 -----------
 
-More detailed information is located in PlatformIO blog: `Building and debugging Atmel AVR (Arduino-based) project using Eclipse IDE+PlatformIO <http://www.ikravets.com/computer-life/programming/2014/06/20/building-and-debugging-atmel-avr-arduino-based-project-using-eclipse-ideplatformio>`_.
+Project Generator
+^^^^^^^^^^^^^^^^^
 
-`More examples (TI MSP430, TI TIVA, etc.) <https://github.com/platformio/platformio/tree/develop/examples/ide-eclipse>`_
+Since PlatformIO 2.0 you can generate Eclipse compatible project using
+:option:`platformio init --ide` command. Please choose board type using
+:ref:`cmd_boards` command and run:
+
+.. code-block:: shell
+
+    platformio init --ide eclipse --board %TYPE%
+
+Then:
+
+1. Import this project via
+   ``Menu: File > Import... > General > Existing Projects into Workspace > Next``
+   and specify root directory where is located :ref:`projectconf`
+2. Open source file from ``src`` directory (``*.c, *.cpp, *.ino, etc.``)
+3. Build project: ``Menu: Project > Build Project``.
+
+
+Manual Integration
+^^^^^^^^^^^^^^^^^^
+
+* `Building and debugging Atmel AVR (Arduino-based) project using Eclipse IDE+PlatformIO <http://www.ikravets.com/computer-life/programming/2014/06/20/building-and-debugging-atmel-avr-arduino-based-project-using-eclipse-ideplatformio>`_
+* `Improvised MBED FRDM-K64F Eclipse/PlatformIO Setup and Software Installation <http://thomasweldon.com/tpw/courses/embeddsp/p00pcFrdmK64_eclipsePlatformioSetup.html>`_
 
 Screenshot
 ----------
 
 .. image:: ../_static/ide-platformio-eclipse.png
-	:target: http://www.ikravets.com/computer-life/programming/2014/06/20/building-and-debugging-atmel-avr-arduino-based-project-using-    eclipse-ideplatformio
+    :target: http://www.ikravets.com/computer-life/programming/2014/06/20/building-and-debugging-atmel-avr-arduino-based-project-using-eclipse-ideplatformio
+
+Examples
+--------
+
+"Blink" Project
+^^^^^^^^^^^^^^^
+
+Source code of `Eclipse "Blink" Project <https://github.com/platformio/platformio/tree/develop/examples/ide/eclipse>`_.

docs/ide/energia.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _ide_energia:
 
 Energia

docs/ide/qtcreator.rst

@@ -0,0 +1,197 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+.. _ide_qtcreator:
+
+Qt Creator
+==========
+
+The `Qt Creator <https://github.com/qtproject/qt-creator>`_ is an open source cross-platform integrated development environment. The editor includes such features as syntax highlighting for various languages, project manager, integrated version control systems, rapid code navigation tools and code autocompletion.
+
+This software can be used with:
+
+* all available :ref:`platforms`
+* all available :ref:`frameworks`
+
+Refer to the `Qt-creator Manual <http://doc.qt.io/qtcreator/>`_
+page for more detailed information.
+
+.. contents::
+
+Integration
+-----------
+
+.. note::
+    Please verify that folder where is located ``platformio`` program is added
+    to `PATH (wiki) <https://en.wikipedia.org/wiki/PATH_(variable)>`_ environment
+    variable. See FAQ: :ref:`faq_troubleshooting_pionotfoundinpath`.
+
+Project Generator
+^^^^^^^^^^^^^^^^^
+
+Since PlatformIO 2.0 you can generate Qt Creator compatible project using
+:option:`platformio init --ide` command. Please choose board type using
+:ref:`cmd_boards` command and run:
+
+.. code-block:: shell
+
+    platformio init --ide qtcreator --board %TYPE%
+
+Then:
+
+1. Import project via ``File > Open File or Project`` and select
+   ``platformio.pro`` from the folder where is located :ref:`projectconf`
+2. Select default desktop kit and click on ``Configure Project`` (``Projects``
+   mode, left panel)
+3. Set ``General > Build directory`` to the project directory where
+   is located :ref:`projectconf`
+4. Remove all items from ``Build Steps``, click on
+   ``Build Steps > Add Build Step > Custom Process Step`` and set:
+
+   * **Command**: ``platformio``
+   * **Arguments**: ``-f -c qtcreator run``
+   * **Working directory**: ``%{buildDir}``
+
+5. Remove all items from ``Clean Steps``, click on
+   ``Clean Steps > Add Clean Step > Custom Process Step`` and set:
+
+   * **Command**: ``platformio``
+   * **Arguments**: ``-f -c qtcreator run --target clean``
+   * **Working directory**: ``%{buildDir}``
+
+6. Update ``PATH`` in ``Build Environment > PATH > EDIT`` with the result of
+   this command (paste in Terminal):
+
+.. code-block:: shell
+
+    # Linux, Mac
+    echo $PATH
+
+    # Windows
+    echo %PATH%
+
+7. Switch to ``Edit`` mode (left panel) and open source file from ``src``
+   directory (``*.c, *.cpp, *.ino, etc.``)
+8. Build project: ``Menu: Build > Build All``.
+
+.. image:: ../_static/ide-platformio-qtcreator-3.png
+    :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-3.png
+
+Manual Integration
+^^^^^^^^^^^^^^^^^^
+
+Setup New Project
+~~~~~~~~~~~~~~~~~
+
+First of all, let's create new project from Qt Creator Start Page: ``New Project`` or using ``Menu: File > New File or Project``, then select project with ``Empty Qt Project`` type (``Other Project > Empty Qt Project``), fill ``Name``, ``Create in``.
+
+.. image:: ../_static/ide-platformio-qtcreator-1.png
+    :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-1.png
+
+On the next steps select any available kit and click Finish button.
+
+.. image:: ../_static/ide-platformio-qtcreator-2.png
+
+Secondly, we need to delete default build and clean steps and configure project with PlatformIO source code builder (click on Projects label on left menu or ``Ctrl+5`` shortcut):
+
+.. image:: ../_static/ide-platformio-qtcreator-3.png
+    :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-3.png
+
+Thirdly, change project file by adding path to directories with header files. Please edit project file to match the following contents:
+
+.. code-block:: none
+
+    win32 {
+        HOMEDIR += $$(USERPROFILE)
+    }
+    else {
+        HOMEDIR += $$(HOME)
+    }
+
+    INCLUDEPATH += "$${HOMEDIR}/.platformio/packages/framework-arduinoavr/cores/arduino"
+    INCLUDEPATH += "$${HOMEDIR}/.platformio/packages/toolchain-atmelavr/avr/include"
+
+.. image:: ../_static/ide-platformio-qtcreator-4.png
+    :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-4.png
+
+First program in Qt Creator
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Simple "Blink" project will consist from two files:
+1. In the console, navigate to the root of your project folder and initialize platformio project with ``platformio init``
+2. The main "C" source file named ``main.c`` must be located in the ``src`` directory.
+Let's create new text file named ``main.c`` using ``Menu: New File or Project > General > Text File``:
+
+.. image:: ../_static/ide-platformio-qtcreator-5.png
+    :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-5.png
+
+Copy the source code which is described below to file ``main.c``.
+
+.. code-block:: c
+
+    #include "Arduino.h"
+    #define WLED    13  // Most Arduino boards already have an LED attached to pin 13 on the board itself
+
+    void setup()
+    {
+      pinMode(WLED, OUTPUT);  // set pin as output
+    }
+
+    void loop()
+    {
+      digitalWrite(WLED, HIGH);  // set the LED on
+      delay(1000);               // wait for a second
+      digitalWrite(WLED, LOW);   // set the LED off
+      delay(1000);               // wait for a second
+    }
+
+3. Locate the project configuration file named ``platformio.ini`` at the root of the project directory and open it.
+
+.. image:: ../_static/ide-platformio-qtcreator-6.png
+    :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-6.png
+
+Edit the content to match the code described below.
+
+.. code-block:: none
+
+    #
+    # Project Configuration File
+    #
+    # A detailed documentation with the EXAMPLES is located here:
+    # http://docs.platformio.org/en/latest/projectconf.html
+    #
+
+    # A sign `#` at the beginning of the line indicates a comment
+    # Comment lines are ignored.
+
+    [env:arduino_uno]
+    platform = atmelavr
+    framework = arduino
+    board = uno
+
+Conclusion
+~~~~~~~~~~
+
+Taking everything into account, we can build project with shortcut ``Ctrl+Shift+B`` or using ``Menu: Build > Build All``.
+
+Screenshot
+----------
+
+.. image:: ../_static/ide-platformio-qtcreator-7.png
+    :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-7.png
+
+Examples
+--------
+
+"Blink" Project
+^^^^^^^^^^^^^^^
+
+Source code of `Qt Creator "Blink" Project <https://github.com/platformio/platformio/tree/develop/examples/ide/qtcreator>`_.

docs/ide/sublimetext.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _ide_sublimetext:
 
 Sublime Text
@@ -7,8 +18,8 @@ The `Sublime Text <http://www.sublimetext.com/>`_ is a cross-platform text and s
 
 This software can be used with:
 
-* all availalbe :ref:`platforms`
-* all availalbe :ref:`frameworks`
+* all available :ref:`platforms`
+* all available :ref:`frameworks`
 
 Refer to the `Sublime Text Documentation <http://docs.sublimetext.info/en/latest>`_
 page for more detailed information.
@@ -18,27 +29,55 @@ page for more detailed information.
 Integration
 -----------
 
+Project Generator
+^^^^^^^^^^^^^^^^^
+
+Since PlatformIO 2.0 you can generate Sublime Text compatible project using
+:option:`platformio init --ide` command. Please choose board type using
+:ref:`cmd_boards` command and run:
+
+.. code-block:: shell
+
+    platformio init --ide sublimetext --board %TYPE%
+
+Then:
+
+1. Import project via ``Menu: Project > Open Project...`` and select
+   ``platformio.sublime-project`` from the folder where is located :ref:`projectconf`
+2. Select PlatformIO as build system: ``Menu: Tools > Build System > PlatformIO``
+3. Open source file from ``src`` directory (``*.c, *.cpp, *.ino, etc.``)
+4. Build project: ``Menu: Tools > Build``.
+
+
+Manual Integration
+^^^^^^^^^^^^^^^^^^
+
+.. note::
+    Please verify that folder where is located ``platformio`` program is added
+    to `PATH (wiki) <https://en.wikipedia.org/wiki/PATH_(variable)>`_ environment
+    variable. See FAQ: :ref:`faq_troubleshooting_pionotfoundinpath`.
+
 Initial configuration
-^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~
 
 First of all, we need to create "New Build System" with name "PlatformIO"
-from ``Menu: Tools → Build System → New Build System`` and fill it like
+from ``Menu: Tools > Build System > New Build System`` and fill it like
 described below:
 
 .. code-block:: bash
 
     {
-        "cmd": ["platformio", "run"],
+        "cmd": ["platformio", "-f", "-c", "sublimetext", "run"],
         "working_dir": "${project_path:${folder}}",
         "variants":
         [
             {
                 "name": "Clean",
-                "cmd": ["platformio", "run", "-t", "clean"]
+                "cmd": ["platformio", "-f", "-c", "sublimetext", "run", "--target", "clean"]
             },
             {
                 "name": "Upload",
-                "cmd": ["platformio", "run", "-t", "upload"]
+                "cmd": ["platformio", "-f", "-c", "sublimetext", "run", "--target", "upload"]
             }
         ]
     }
@@ -48,16 +87,16 @@ Secondly, we need to select "PlatformIO" Build System from a list:
 .. image:: ../_static/ide-sublime-text-platformio-newproject-2.png
 
 After that, we can use the necessary commands from
-``Menu: Tools → Command Palette`` or with ``Ctrl+Shift+P`` (Windows/Linux)
+``Menu: Tools > Command Palette`` or with ``Ctrl+Shift+P`` (Windows/Linux)
 ``Cmd+Shift+P`` (Mac) shortcut.
 
 .. image:: ../_static/ide-sublime-text-platformio-newproject-3.png
 
 Command Hotkeys
-~~~~~~~~~~~~~~~
+'''''''''''''''
 
 Sublime Text allows to bind own hotkey per command. Let's setup them
-for PlatformIO commands using shortcut ``Menu: Preferences → Key-Bindings - User``:
+for PlatformIO commands using shortcut ``Menu: Preferences > Key-Bindings - User``:
 
 .. image:: ../_static/ide-sublime-text-platformio-newproject-4.png
 
@@ -76,12 +115,12 @@ In this case, the final code will look like:
     ]
 
 First program in Sublime Text
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Simple "Blink" project will consist from two files:
 
 1. Main "C" source file named ``main.c`` must be located in the ``src`` directory.
-Let's create new file named ``main.c`` using ``Menu: File → New File`` or shortcut ``Ctrl+N`` (Windows/Linux) ``Cmd+N`` (Mac) with the next contents:
+Let's create new file named ``main.c`` using ``Menu: File > New File`` or shortcut ``Ctrl+N`` (Windows/Linux) ``Cmd+N`` (Mac) with the next contents:
 
 .. code-block:: c
 
@@ -122,8 +161,19 @@ Copy the source code which is described below to it.
     board = uno
 
 Conclusion
+~~~~~~~~~~
+
+Taking everything into account, we can open project directory in Sublime Text using ``Menu: File > Open Folder`` and build it with shortcut ``Ctrl+B`` (Windows/Linux) or ``Cmd+B`` (Mac), clean project with shortcut ``F11`` and upload firmware to target with shortcut ``F12``.
+
+Screenshot
 ----------
 
-Taking everything into account, we can open project directory in Sublime Text using ``Menu: File → Open Folder`` and build it with shortcut ``Ctrl+B`` (Windows/Linux) or ``Cmd+B`` (Mac), clean project with shortcut ``F11`` and upload firmware to target with shortcut ``F12``.
-
 .. image:: ../_static/ide-sublime-text-platformio-newproject-5.png
+
+Examples
+--------
+
+"Blink" Project
+^^^^^^^^^^^^^^^
+
+Source code of `Sublime Text "Blink" Project <https://github.com/platformio/platformio/tree/develop/examples/ide/sublimetext>`_.

docs/ide/vim.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _ide_vim:
 
 VIM
@@ -9,12 +20,17 @@ standalone application in a graphical user interface.
 
 This software can be used with:
 
-* all availalbe :ref:`platforms`
-* all availalbe :ref:`frameworks`
+* all available :ref:`platforms`
+* all available :ref:`frameworks`
 
 Integration
 -----------
 
+.. note::
+    Please verify that folder where is located ``platformio`` program is added
+    to `PATH (wiki) <https://en.wikipedia.org/wiki/PATH_(variable)>`_ environment
+    variable. See FAQ: :ref:`faq_troubleshooting_pionotfoundinpath`.
+
 Recommended bundles:
 
 * Syntax highlight - `Arduino-syntax-file <https://github.com/vim-scripts/Arduino-syntax-file>`_
@@ -30,10 +46,10 @@ Put to the project directory ``Makefile`` wrapper with contents:
     #PATH := /usr/local/bin:$(PATH)
 
     all:
-        platformio run -t upload
+        platformio -f -c vim run --target upload
 
     clean:
-        platformio run -t clean
+        platformio -f -c vim run --target clean
 
 
 Now, in VIM ``cd /path/to/this/project`` and press ``Ctrl+B`` or ``Cmd+B``

docs/ide/visualstudio.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _ide_visualstudio:
 
 Visual Studio
@@ -7,8 +18,8 @@ The `Microsoft Visual Studio (Free) <http://visualstudio.com/free>`_ is an integ
 
 This software can be used with:
 
-* all availalbe :ref:`platforms`
-* all availalbe :ref:`frameworks`
+* all available :ref:`platforms`
+* all available :ref:`frameworks`
 
 Refer to the `Visual Studio Documentation <https://msdn.microsoft.com/library/vstudio>`_
 page for more detailed information.
@@ -18,10 +29,36 @@ page for more detailed information.
 Integration
 -----------
 
-Setup New Project
+.. note::
+    Please verify that folder where is located ``platformio`` program is added
+    to `PATH (wiki) <https://en.wikipedia.org/wiki/PATH_(variable)>`_ environment
+    variable. See FAQ: :ref:`faq_troubleshooting_pionotfoundinpath`.
+
+Project Generator
 ^^^^^^^^^^^^^^^^^
 
-First of all, let's create new project from Visual Studio Start Page: ``Start → New Project`` or using ``Menu: File → New → Project``, then select project with ``Makefile`` type (``Visual C++ → General → Makefile Project``), fill ``Project name``, ``Solution name``, ``Location`` fields and press OK button.
+Since PlatformIO 2.0 you can generate Visual Studio compatible project using
+:option:`platformio init --ide` command. Please choose board type using
+:ref:`cmd_boards` command and run:
+
+.. code-block:: shell
+
+    platformio init --ide visualstudio --board %TYPE%
+
+Then:
+
+1. Import this project via ``Menu: File > Open > Project/Solution``
+   and specify root directory where is located :ref:`projectconf`
+2. Open source file from ``src`` directory (``*.c, *.cpp, *.ino, etc.``)
+3. Build project: ``Menu: Build > Build Solution``.
+
+Manual Integration
+^^^^^^^^^^^^^^^^^^
+
+Setup New Project
+~~~~~~~~~~~~~~~~~
+
+First of all, let's create new project from Visual Studio Start Page: ``Start > New Project`` or using ``Menu: File > New > Project``, then select project with ``Makefile`` type (``Visual C++ > General > Makefile Project``), fill ``Project name``, ``Solution name``, ``Location`` fields and press OK button.
 
 .. image:: ../_static/ide-vs-platformio-newproject.png
 
@@ -37,7 +74,7 @@ Release Configuration is the same as Debug, so on the next step we check "Same a
 
 .. image:: ../_static/ide-vs-platformio-newproject-3.png
 
-Thirdly, we need to add directories with header files using project properties (right click on the project name or ``Alt-Enter`` shortcut) and add two directories to ``Configuration Properties → NMake → Include Search Path``:
+Thirdly, we need to add directories with header files using project properties (right click on the project name or ``Alt-Enter`` shortcut) and add two directories to ``Configuration Properties > NMake > Include Search Path``:
 
 .. code-block:: none
 
@@ -47,12 +84,12 @@ Thirdly, we need to add directories with header files using project properties (
 .. image:: ../_static/ide-vs-platformio-newproject-5.png
 
 First program in Visual Studio
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Simple "Blink" project will consist from two files:
 
 1. Main "C" source file named ``main.c`` must be located in the ``src`` directory.
-Let's create new file named ``main.c`` using ``Menu: File → New File`` or shortcut ``Ctrl+N``:
+Let's create new file named ``main.c`` using ``Menu: File > New File`` or shortcut ``Ctrl+N``:
 
 .. image:: ../_static/ide-vs-platformio-newproject-6.png
 
@@ -101,8 +138,20 @@ Copy the source code which is described below to it.
 
 
 Conclusion
+~~~~~~~~~~
+
+Taking everything into account, we can build project with shortcut ``Ctrl+Shift+B`` or using ``Menu: Build > Build Solution``.
+
+Screenshot
 ----------
 
-Taking everything into account, we can build project with shortcut ``Ctrl+Shift+B`` or using ``Menu: Build → Build Solution``:
-
 .. image:: ../_static/ide-vs-platformio-newproject-8.png
+    :target: http://docs.platformio.org/en/latest/_static/ide-vs-platformio-newproject-8.png
+
+Examples
+--------
+
+"Blink" Project
+^^^^^^^^^^^^^^^
+
+Source code of `Visual Studio "Blink" Project <https://github.com/platformio/platformio/tree/develop/examples/ide/visualstudio>`_.

docs/index.rst

@@ -1,8 +1,23 @@
-PlatformIO: A cross-platform code builder and the missing library manager
-=========================================================================
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
 
-*Atmel AVR & SAM, Freescale Kinetis, Nordic nRF51, NXP LPC, ST STM32,
-TI MSP430 & Tiva, Teensy, Arduino, mbed, libOpenCM3, etc.*
+PlatformIO is an open-source cross-platform code builder and the missing library manager
+========================================================================================
+
+**Ready for embedded development, IDE and Continuous integration, Arduino and
+MBED compatible**
+
+*Atmel AVR & SAM, Espressif, Freescale Kinetis, Nordic nRF51, NXP LPC,
+Silicon Labs EFM32, ST STM32, TI MSP430 & Tiva, Teensy, Arduino, mbed,
+libOpenCM3, etc.*
 
 .. image:: _static/platformio-logo.png
     :target: http://platformio.org
@@ -14,8 +29,10 @@ TI MSP430 & Tiva, Teensy, Arduino, mbed, libOpenCM3, etc.*
 * `Source Code <https://github.com/platformio/platformio>`_ |
   `Issues <https://github.com/platformio/platformio/issues>`_
 * `Blog <http://www.ikravets.com/category/computer-life/platformio>`_ |
-  `Reddit <http://www.reddit.com/r/platformio/>`_ |
-  `Twitter <https://twitter.com/PlatformIO_Org>`_
+  `Twitter <https://twitter.com/PlatformIO_Org>`_ |
+  `Hackaday <https://hackaday.io/project/7980-platformio>`_ |
+  `Facebook <https://www.facebook.com/platformio>`_ |
+  `Reddit <http://www.reddit.com/r/platformio/>`_
 
 You have **no need** to install any *IDE* or compile any tool chains. *PlatformIO*
 has pre-built different development platforms and pre-configured settings for
@@ -26,10 +43,13 @@ Embedded Development. *Easier Than Ever.*
 -----------------------------------------
 
 * Colourful command-line output
-* Built-in :ref:`Serial Port Monitor <cmd_serialports_monitor>`
-* Configurable build :ref:`-flags/-options <projectconf_build_flags>`
-* Integration with :ref:`development environments (IDE) <ide>`
-* Pre-built tool chains, :ref:`frameworks` for the popular Hardware Platforms
+* :ref:`IDE Integration <ide>` with *Arduino, Eclipse, Energia, Qt Creator,
+  Sublime Text, Vim, Visual Studio*
+* :ref:`ci` with *AppVeyor, Circle CI, Drone, Shippable, Travis CI*
+* Built-in :ref:`Serial Port Monitor <cmd_serialports_monitor>` and
+  configurable build :ref:`-flags/-options <projectconf_build_flags>`
+* Pre-built tool chains, :ref:`frameworks` for the
+  :ref:`Development Platforms <platforms>`
 
 Smart Code Builder. *Fast and Reliable.*
 ----------------------------------------
@@ -53,17 +73,40 @@ Contents
 --------
 
 .. toctree::
+    :caption: Getting Started
     :maxdepth: 2
 
-    quickstart
+    demo
     installation
+    quickstart
+    userguide/index
+
+.. toctree::
+    :caption: Configuration
+    :maxdepth: 2
+
     projectconf
     envvars
+
+.. toctree::
+    :caption: Instruments
+    :maxdepth: 2
+
     Platforms & Boards <platforms/index>
     frameworks/index
+
+.. toctree::
+    :caption: Integration
+    :maxdepth: 2
+
     librarymanager/index
-    userguide/index
+    ci/index
     ide
+
+.. toctree::
+    :caption: Miscellaneous
+    :maxdepth: 2
+
     articles
     FAQ <faq>
     history

docs/installation.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _installation:
 
 Installation
@@ -18,53 +29,78 @@ System requirements
     * Mac OS X
     * Linux, +ARM
     * Windows
-* `Python 2.6 or Python 2.7 <https://www.python.org/downloads/>`_
+* Python 2.6.x or Python 2.7.x(recommended)
 
 All commands below should be executed in
 `Command-line <http://en.wikipedia.org/wiki/Command-line_interface>`_
-application:
+application (Terminal):
 
-* *Mac OS X / Linux* this is *Terminal* application.
-* *Windows* this is
-  `Command Prompt <http://en.wikipedia.org/wiki/Command_Prompt>`_ (``cmd.exe``)
-  application.
+* Mac OS X / Linux – *Terminal* application
+* Windows – ``cmd.exe`` application.
 
-.. warning::
-    If you are going to run *PlatformIO* from **subprocess**, you
-    :ref:`MUST DISABLE <faq_troubleshooting_pioblocksprompt>` all prompts.
-    It will allow you to avoid blocking.
-
-
-Troubleshooting
----------------
-
-For further details, frequently questions, please refer to :ref:`faq`.
-
-Installation Methods
+Installation options
 --------------------
 
-Please *choose one of* the following installation methods:
+.. warning::
+    **Windows OS**: Please `Download the latest Python 2.7.x
+    <https://www.python.org/downloads/>`_ and install it.
+    **DON'T FORGET** to select ``Add python.exe to Path`` feature on the
+    "Customize" stage.
+
+Please *choose one of* the following installation options:
+
+Python Package Manager
+~~~~~~~~~~~~~~~~~~~~~~
+
+The latest stable version of PlatformIO may be installed/upgraded via
+`pip <https://pip.pypa.io>`_ as follows:
+
+.. code-block:: bash
+
+    # update dependent packages to the latest versions
+    pip install -U pip setuptools
+
+    # install/upgrade the latest version of PlatformIO
+    pip install -U platformio
+
+Note that you may run into permissions issues running these commands. You have
+a few options here:
+
+* Run with ``sudo`` to install PlatformIO and dependencies globally
+* Specify the `pip install --user <https://pip.pypa.io/en/stable/user_guide.html#user-installs>`_
+  option to install local to your user
+* Run the command in a `virtualenv <https://virtualenv.pypa.io>`_ local to a
+  specific project working set.
+
+.. _installation_installer_script:
+
+Installer Script
+~~~~~~~~~~~~~~~~
 
 Super-Quick (Mac / Linux)
-~~~~~~~~~~~~~~~~~~~~~~~~~
+'''''''''''''''''''''''''
 
 To install or upgrade *PlatformIO* paste that at a *Terminal* prompt
-(**you might need** to run ``sudo`` first):
+(**MAY require** administrator access ``sudo``):
 
 .. code-block:: bash
 
     python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
 
 
-Installer Script (Mac / Linux / Windows)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Local Download (Mac / Linux / Windows)
+''''''''''''''''''''''''''''''''''''''
 
-To install or upgrade *PlatformIO*, download
+To install or upgrade *PlatformIO*, download (save as...)
 `get-platformio.py <https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py>`_
-script. Then run the following (you might need to run ``sudo`` first):
+script. Then run the following (**MAY require** administrator access ``sudo``):
 
 .. code-block:: bash
 
+    # change directory to folder where is located downloaded "get-platformio.py"
+    cd /path/to/dir/where/is/located/get-platformio.py/script
+
+    # run it
     python get-platformio.py
 
 
@@ -72,6 +108,10 @@ On *Windows OS* it may look like:
 
 .. code-block:: bash
 
+    # change directory to folder where is located downloaded "get-platformio.py"
+    cd C:\path\to\dir\where\is\located\get-platformio.py\script
+
+    # run it
     C:\Python27\python.exe get-platformio.py
 
 Full Guide
@@ -81,59 +121,57 @@ Full Guide
 
 .. code-block:: bash
 
-    $ python --version
+    python --version
 
-*Windows OS* Users only:
+*Windows Users* only:
 
     * `Download Python 2.7 <https://www.python.org/downloads/>`_ and install it.
-    * Add to PATH system variable ``;C:\Python27;C:\Python27\Scripts;`` and
-       reopen *Command Prompt* (``cmd.exe``) application. Please read this
-       article `How to set the path and environment variables in Windows
-       <http://www.computerhope.com/issues/ch000549.htm>`_.
+    * Add to PATH system variable ``;C:\Python27;C:\Python27\Scripts;`` and reopen *Command Prompt* (``cmd.exe``) application. Please read this article `How to set the path and environment variables in Windows <http://www.computerhope.com/issues/ch000549.htm>`_.
 
-
-2. Check a ``pip`` tool for installing and managing *Python* packages:
+2. Install a ``platformio`` and related packages:
 
 .. code-block:: bash
 
-    $ pip search platformio
-
-You should see short information about ``platformio`` package.
+    pip install -U pip setuptools
+    pip install -U platformio
 
 If your computer does not recognize ``pip`` command, try to install it first
 using `these instructions <https://pip.pypa.io/en/latest/installing.html>`_.
 
-3. Install a ``platformio`` and related packages:
+For upgrading ``platformio`` to the latest version:
 
 .. code-block:: bash
 
-    $ pip install platformio && pip install --egg scons
-
-For upgrading the ``platformio`` to new version please use this command:
-
-.. code-block:: bash
-
-    $ pip install -U platformio
-
+    pip install -U platformio
 
 Development Version
 ~~~~~~~~~~~~~~~~~~~
 
-.. warning::
-    We don't recommend to use ``develop`` version in production.
-
-1. If you had have already installed PlatformIO, please uninstall it:
+Install the latest PlatformIO from the ``develop`` branch:
 
 .. code-block:: bash
 
-    $ pip uninstall platformio
-
-2. Install the latest PlatformIO from the ``develop`` branch:
-
-.. code-block:: bash
-
-    $ pip install https://github.com/platformio/platformio/archive/develop.zip
+    pip install -U pip setuptools
+    pip install -U https://github.com/platformio/platformio/archive/develop.zip
 
 If you want to be up-to-date with the latest ``develop`` version of PlatformIO,
-then you need to perform step #2 each time if you see the new commits in
-`PlatformIO GitHub repository <https://github.com/platformio/platformio/commits/develop>`_.
+then you need to re-install PlatformIO each time if you see the new commits in
+`PlatformIO GitHub repository (branch: develop) <https://github.com/platformio/platformio/commits/develop>`_.
+
+Troubleshooting
+---------------
+
+.. warning::
+    If you are going to run *PlatformIO* from **subprocess**, you
+    :ref:`MUST DISABLE <faq_troubleshooting_pioblocksprompt>` all prompts.
+    It will allow you to avoid blocking.
+
+.. note::
+    **Linux OS**: Don't forget to install "udev" rules file
+    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
+
+    **Windows OS**: Please check that you have correctly installed USB driver
+    from board manufacturer
+
+For further details, frequently questions, known issues, please
+refer to :ref:`faq`.

docs/librarymanager/config.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. |PIOAPICR| replace:: *PlatformIO Library Registry Crawler*
 .. _library_config:
 
@@ -249,6 +260,12 @@ patterns.
 A list with compatible frameworks. The available framework types are defined in
 the :ref:`platforms` section.
 
+If the library is compatible with the all frameworks, then you can use ``*``
+symbol:
+
+.. code-block:: javascript
+
+    "frameworks": "*"
 
 .. _libjson_platforms:
 
@@ -260,6 +277,13 @@ the :ref:`platforms` section.
 A list with compatible platforms. The available platform types are
 defined in :ref:`platforms` section.
 
+If the library is compatible with the all platforms, then you can use ``*``
+symbol:
+
+.. code-block:: javascript
+
+    "platforms": "*"
+
 
 .. _libjson_dependencies:
 

docs/librarymanager/creating.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _library_creating:
 .. |PIOAPICR| replace:: *PlatformIO Library Registry Crawler*
 
@@ -134,3 +145,4 @@ The registration requirements:
 
 Now, you can :ref:`register <cmd_lib_register>` your library and allow others
 to :ref:`install <cmd_lib_install>` it.
+

docs/librarymanager/index.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _librarymanager:
 
 Library Manager
@@ -8,8 +19,10 @@ Library Manager
     *"The missing library manager for development platforms"* [#]_
 
 *PlatformIO Library Manager* allows you to organize external embedded libraries.
-You can search for new libraries via :ref:`Command Line interface <cmd_lib_search>`
-or `Web 2.0 Library Search <http://platformio.org/#!/lib>`_.
+You can search for new libraries via
+
+* :ref:`Command Line interface <cmd_lib_search>`
+* `Web 2.0 Library Search <http://platformio.org/#!/lib>`_
 
 You don't need to bother for finding the latest version of library. Due to
 :ref:`cmd_lib_update` command you will have up-to-date external libraries.

docs/platforms/atmelavr.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _platform_atmelavr:
 
 Platform ``atmelavr``
@@ -33,6 +44,9 @@ Packages
     **Linux Users:** Don't forget to install "udev" rules file
     `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
 
+    **Windows Users:** Please check that you have correctly installed USB driver
+    from board manufacturer
+
 
 
 Frameworks
@@ -75,6 +89,13 @@ Adafruit
       - 32 Kb
       - 2.5 Kb
 
+    * - ``gemma``
+      - `Adafruit Gemma <http://www.adafruit.com/products/1222>`_
+      - ATTINY85
+      - 8 MHz
+      - 8 Kb
+      - 0.5 Kb
+
     * - ``protrinket3``
       - `Adafruit Pro Trinket 3V/12MHz (USB) <http://www.adafruit.com/products/2010>`_
       - ATMEGA328P
@@ -591,6 +612,26 @@ PanStamp
       - 32 Kb
       - 2 Kb
 
+Punch Through
+~~~~~~~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``lightblue-bean``
+      - `LightBlue Bean <https://punchthrough.com/bean>`_
+      - ATMEGA328P
+      - 8 MHz
+      - 32 Kb
+      - 2 Kb
+
 Quirkbot
 ~~~~~~~~
 
@@ -816,8 +857,8 @@ TinyCircuits
       - 32 Kb
       - 2 Kb
 
-WickedDevice
-~~~~~~~~~~~~
+Wicked Device
+~~~~~~~~~~~~~
 
 .. list-table::
     :header-rows:  1
@@ -830,15 +871,35 @@ WickedDevice
       - RAM
 
     * - ``wildfirev2``
-      - `WickedDevice WildFire v2 [stk500] <http://shop.wickeddevice.com/resources/wildfire/#arduinoidesetup>`_
+      - `Wicked Device WildFire V2 <http://shop.wickeddevice.com/resources/wildfire/>`_
       - ATMEGA1284P
       - 16 MHz
       - 128 Kb
       - 16 Kb
 
     * - ``wildfirev3``
-      - `WickedDevice WildFire v3 [optiboot] <http://shop.wickeddevice.com/resources/wildfire/>`_
+      - `Wicked Device WildFire V3 <http://shop.wickeddevice.com/resources/wildfire/>`_
       - ATMEGA1284P
       - 16 MHz
       - 128 Kb
       - 16 Kb
+
+ubIQio
+~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``ardhat``
+      - `ubIQio Ardhat <http://ardhat.com>`_
+      - ATMEGA328P
+      - 16 MHz
+      - 32 Kb
+      - 2 Kb

docs/platforms/atmelsam.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _platform_atmelsam:
 
 Platform ``atmelsam``
@@ -33,6 +44,9 @@ Packages
     **Linux Users:** Don't forget to install "udev" rules file
     `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
 
+    **Windows Users:** Please check that you have correctly installed USB driver
+    from board manufacturer
+
 
 
 Frameworks

docs/platforms/creating_board.rst

@@ -0,0 +1,73 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+.. _board_creating:
+
+Creating Board
+==============
+
+*PlatformIO* has pre-built settings for the most popular embedded boards. This
+list is available:
+
+* `Embedded Boards Explorer <http://platformio.org/#!/boards>`_ (Web)
+* :ref:`cmd_boards` (CLI command)
+
+Nevertheless, PlatformIO allows to create own board or override existing
+board's settings. All data is declared using
+`JSON-style <http://en.wikipedia.org/wiki/JSON>`_ via
+`associative array <http://en.wikipedia.org/wiki/Associative_array>`_
+(name/value pairs).
+
+.. contents::
+
+JSON Structure
+--------------
+
+The key fields:
+
+* ``build`` data will be used by :ref:`Platforms <platforms>` and
+  :ref:`frameworks` builders
+* ``frameworks`` is the list with supported :ref:`frameworks`
+* ``platform`` main type of :ref:`Platforms <platforms>`
+* ``upload`` upload settings which depend on the ``platform``
+
+.. code-block:: json
+
+    {
+        "myboard": {
+            "build": {},
+            "frameworks": ["%LIST_WITH_SUPPORTED_FRAMEWORKS%"],
+            "name": "My test board",
+            "platform": "%PLATFORM_TYPE_HERE%",
+            "upload": {},
+            "url": "http://example.com",
+            "vendor": "My Company Ltd."
+        }
+    }
+
+Installation
+------------
+
+1. Create ``boards`` directory in :ref:`projectconf_pio_home_dir` if it
+   doesn't exist.
+2. Create ``my_own_boards.json`` file and put to ``boards`` directory.
+3. Search available boards via :ref:`cmd_boards` command. You should see
+   ``myboard`` board.
+
+Now, you can use ``myboard`` for the :ref:`projectconf_env_board` option in
+:ref:`projectconf`.
+
+
+Examples
+--------
+
+For the examples, please look into built-in ``*.json`` files with boards
+settings: https://github.com/platformio/platformio/tree/develop/platformio/boards.

docs/platforms/creating_platform.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _platform_creating:
 
 Creating Platform
@@ -108,9 +119,21 @@ Packages
     * - ``toolchain-atmelavr``
       - `avr-gcc <https://gcc.gnu.org/wiki/avr-gcc>`_, `GDB <http://www.gnu.org/software/gdb/>`_, `AVaRICE <http://avarice.sourceforge.net/>`_, `SimulAVR <http://www.nongnu.org/simulavr/>`_
 
+    * - ``toolchain-gccarmlinuxgnueabi``
+      - `GCC for Linux ARM GNU EABI <https://gcc.gnu.org>`_, `GDB <http://www.gnu.org/software/gdb/>`_
+
     * - ``toolchain-gccarmnoneeabi``
       - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_, `GDB <http://www.gnu.org/software/gdb/>`_
 
+    * - ``toolchain-gcclinux32``
+      - `GCC for Linux i686 <https://gcc.gnu.org>`_
+
+    * - ``toolchain-gcclinux64``
+      - `GCC for Linux x86_64 <https://gcc.gnu.org>`_
+
+    * - ``toolchain-gccmingw32``
+      - `MinGW <http://www.mingw.org>`_
+
     * - ``toolchain-timsp430``
       - `msp-gcc <http://sourceforge.net/projects/mspgcc/>`_, `GDB <http://www.gnu.org/software/gdb/>`_
 
@@ -145,6 +168,8 @@ Example of the **test** platform (``test.py``):
 
 .. code-block:: python
 
+    import os
+
     from platformio.platforms.base import BasePlatform
 
     class TestPlatform(BasePlatform):
@@ -198,7 +223,7 @@ Build Script
 
 Platform's build script is based on a next-generation build tool named
 `SCons <http://www.scons.org>`_. PlatformIO has own built-in firmware builder
-``env.BuildFirmware`` with the nested libraries search. Please look into a
+``env.BuildProgram`` with the nested libraries search. Please look into a
 base template of ``test-builder.py``.
 
 .. code-block:: python
@@ -258,7 +283,7 @@ base template of ``test-builder.py``.
     #
     # Target: Build executable and linkable firmware
     #
-    target_elf = env.BuildFirmware()
+    target_elf = env.BuildProgram()
 
     #
     # Target: Build the .bin file
@@ -292,11 +317,126 @@ Installation
 ------------
 
 1. Create ``platforms`` directory in :ref:`projectconf_pio_home_dir` if it
-   doesn't exists.
+   doesn't exist.
 2. Copy ``test.py`` and ``test-builder.py`` files to ``platforms`` directory.
-3. Search available platforms via :ref:`cmd_search` command. You should see
+3. Search available platforms via :ref:`cmd_platforms_search` command. You should see
    ``test`` platform.
-4. Install ``test`` platform via :ref:`cmd_install` command.
+4. Install ``test`` platform via :ref:`cmd_platforms_install` command.
 
 Now, you can use ``test`` for the :ref:`projectconf_env_platform` option in
 :ref:`projectconf`.
+
+Example
+-------
+
+Let's use the real example which was requested by our user in `issue 175 <https://github.com/platformio/platformio/issues/175>`_. Need to add support for uploading firmware using GDB to
+:ref:`platform_ststm32`.
+
+First of all, need to create new folder ``platforms`` in :ref:`projectconf_pio_home_dir`
+and copy there two files:
+
+1. Platform manifest file ``ststm32gdb.py`` with the next content:
+
+.. code-block:: python
+
+    import os
+
+    from platformio.platforms.ststm32 import Ststm32Platform
+
+
+    class Ststm32gdbPlatform(Ststm32Platform):
+
+        """
+        ST STM32 using GDB as uploader
+
+        http://www.st.com/web/en/catalog/mmc/FM141/SC1169?sc=stm32
+        """
+
+        def get_build_script(self):
+
+            return os.path.join(
+                os.path.dirname(os.path.realpath(__file__)),
+                "ststm32gdb-builder.py"
+            )
+
+2. Build script file ``ststm32gdb-builder.py`` with the next content:
+
+.. code-block:: python
+
+    """
+        Builder for ST STM32 Series ARM microcontrollers with GDB upload.
+    """
+
+    from os.path import join
+
+    from SCons.Script import (COMMAND_LINE_TARGETS, AlwaysBuild, Default,
+                              DefaultEnvironment, SConscript)
+
+
+    env = DefaultEnvironment()
+
+    SConscript(env.subst(join("$PIOBUILDER_DIR", "scripts", "basearm.py")))
+
+    env.Replace(
+        UPLOADER=join(
+            "$PIOPACKAGES_DIR", "toolchain-gccarmnoneeabi",
+            "bin", "arm-none-eabi-gdb"
+        ),
+        UPLOADERFLAGS=[
+            join("$BUILD_DIR", "firmware.elf"),
+            "-batch",
+            "-x", join("$PROJECT_DIR", "upload.gdb")
+        ],
+
+        UPLOADCMD="$UPLOADER $UPLOADERFLAGS"
+    )
+
+    env.Append(
+        CPPDEFINES=[
+            "${BOARD_OPTIONS['build']['variant'].upper()}"
+        ],
+
+        LINKFLAGS=[
+            "-nostartfiles",
+            "-nostdlib"
+        ]
+    )
+
+    #
+    # Target: Build executable and linkable firmware
+    #
+
+    target_elf = env.BuildProgram()
+
+    #
+    # Target: Build the .bin file
+    #
+
+    if "uploadlazy" in COMMAND_LINE_TARGETS:
+        target_firm = join("$BUILD_DIR", "firmware.bin")
+    else:
+        target_firm = env.ElfToBin(join("$BUILD_DIR", "firmware"), target_elf)
+
+    #
+    # Target: Print binary size
+    #
+
+    target_size = env.Alias("size", target_elf, "$SIZEPRINTCMD")
+    AlwaysBuild(target_size)
+
+    #
+    # Target: Upload by default .bin file
+    #
+
+    upload = env.Alias(
+        ["upload", "uploadlazy"], target_firm, "$UPLOADCMD")
+    AlwaysBuild(upload)
+
+    #
+    # Target: Define targets
+    #
+
+    Default([target_firm, target_size])
+
+Now, we should see ``ststm32gdb`` platform using :ref:`cmd_platforms_search` command output
+and can install it via :ref:`platformio platforms install ststm32gdb <cmd_platforms_install>` command.

docs/platforms/espressif.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _platform_espressif:
 
 Platform ``espressif``
@@ -36,6 +47,9 @@ Packages
     **Linux Users:** Don't forget to install "udev" rules file
     `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
 
+    **Windows Users:** Please check that you have correctly installed USB driver
+    from board manufacturer
+
 
 
 Frameworks
@@ -72,7 +86,14 @@ Espressif
       - RAM
 
     * - ``esp01``
-      - `Espressif ESP8266 board <https://nurdspace.nl/ESP8266>`_
+      - `Espressif ESP8266 ESP-01 board <https://nurdspace.nl/ESP8266>`_
+      - ESP8266
+      - 40 MHz
+      - 512 Kb
+      - 32 Kb
+
+    * - ``esp12e``
+      - `Espressif ESP8266 ESP-12E board (NodeMCU) <https://nurdspace.nl/ESP8266>`_
       - ESP8266
       - 80 MHz
       - 512 Kb

docs/platforms/freescalekinetis.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _platform_freescalekinetis:
 
 Platform ``freescalekinetis``
@@ -27,6 +38,9 @@ Packages
     **Linux Users:** Don't forget to install "udev" rules file
     `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
 
+    **Windows Users:** Please check that you have correctly installed USB driver
+    from board manufacturer
+
 
 
 Frameworks

docs/platforms/index.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _platforms:
 
 Platforms & Embedded Boards
@@ -11,6 +22,9 @@ Also it has pre-configured settings for most popular **Embedded Platform
 Boards**. You have no need to specify in :ref:`projectconf` type or frequency of
 MCU, upload protocol or etc. Please use ``board`` option.
 
+Embedded
+--------
+
 .. toctree::
     :maxdepth: 2
 
@@ -20,8 +34,29 @@ MCU, upload protocol or etc. Please use ``board`` option.
     freescalekinetis
     nordicnrf51
     nxplpc
+    siliconlabsefm32
     ststm32
     teensy
     timsp430
     titiva
+
+Desktop
+-------
+
+.. toctree::
+    :maxdepth: 2
+
+    native
+    linux_arm
+    linux_i686
+    linux_x86_64
+    windows_x86
+
+Own Platform/Board
+------------------
+
+.. toctree::
+    :maxdepth: 2
+
     creating_platform
+    creating_board

docs/platforms/linux_arm.rst

@@ -0,0 +1,32 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+.. _platform_linux_arm:
+
+Platform ``linux_arm``
+======================
+Linux ARM is a Unix-like and mostly POSIX-compliant computer operating system (OS) assembled under the model of free and open-source software development and distribution. Using host OS (Mac OS X, Linux ARM) you can build native application for Linux ARM platform.
+
+For more detailed information please visit `vendor site <http://platformio.org/#!/platforms/linux_arm>`_.
+
+.. contents::
+
+Packages
+--------
+
+.. list-table::
+    :header-rows:  1
+
+    * - Name
+      - Contents
+
+    * - ``toolchain-gccarmlinuxgnueabi``
+      - `GCC for Linux ARM GNU EABI <https://gcc.gnu.org>`_, `GDB <http://www.gnu.org/software/gdb/>`_

docs/platforms/linux_i686.rst

@@ -0,0 +1,32 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+.. _platform_linux_i686:
+
+Platform ``linux_i686``
+=======================
+Linux i686 (32-bit) is a Unix-like and mostly POSIX-compliant computer operating system (OS) assembled under the model of free and open-source software development and distribution. Using host OS (Mac OS X or Linux 32-bit) you can build native application for Linux i686 platform.
+
+For more detailed information please visit `vendor site <http://platformio.org/#!/platforms/linux_i686>`_.
+
+.. contents::
+
+Packages
+--------
+
+.. list-table::
+    :header-rows:  1
+
+    * - Name
+      - Contents
+
+    * - ``toolchain-gcclinux32``
+      - `GCC for Linux i686 <https://gcc.gnu.org>`_

docs/platforms/linux_x86_64.rst

@@ -0,0 +1,32 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+.. _platform_linux_x86_64:
+
+Platform ``linux_x86_64``
+=========================
+Linux x86_64 (64-bit) is a Unix-like and mostly POSIX-compliant computer operating system (OS) assembled under the model of free and open-source software development and distribution. Using host OS (Mac OS X or Linux 64-bit) you can build native application for Linux x86_64 platform.
+
+For more detailed information please visit `vendor site <http://platformio.org/#!/platforms/linux_i686>`_.
+
+.. contents::
+
+Packages
+--------
+
+.. list-table::
+    :header-rows:  1
+
+    * - Name
+      - Contents
+
+    * - ``toolchain-gcclinux64``
+      - `GCC for Linux x86_64 <https://gcc.gnu.org>`_

docs/platforms/native.rst

@@ -0,0 +1,20 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+.. _platform_native:
+
+Platform ``native``
+===================
+Native development platform is intended to be used for desktop OS. This platform uses built-in tool chains (preferable based on GCC), frameworks, libs from particular OS where it will be run.
+
+For more detailed information please visit `vendor site <http://platformio.org/#!/platforms/native>`_.
+
+.. contents::

docs/platforms/nordicnrf51.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _platform_nordicnrf51:
 
 Platform ``nordicnrf51``
@@ -27,6 +38,9 @@ Packages
     **Linux Users:** Don't forget to install "udev" rules file
     `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
 
+    **Windows Users:** Please check that you have correctly installed USB driver
+    from board manufacturer
+
 
 
 Frameworks
@@ -49,6 +63,26 @@ Boards
     * For more detailed ``board`` information please scroll tables below by
       horizontal.
 
+Delta
+~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``dfcm_nnn40``
+      - `Delta DFCM-NNN40 <https://developer.mbed.org/platforms/Delta-DFCM-NNN40/>`_
+      - NRF51822
+      - 32 MHz
+      - 256 Kb
+      - 32 Kb
+
 JKSoft
 ~~~~~~
 

docs/platforms/nxplpc.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _platform_nxplpc:
 
 Platform ``nxplpc``
@@ -27,6 +38,9 @@ Packages
     **Linux Users:** Don't forget to install "udev" rules file
     `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
 
+    **Windows Users:** Please check that you have correctly installed USB driver
+    from board manufacturer
+
 
 
 Frameworks

docs/platforms/siliconlabsefm32.rst

@@ -0,0 +1,112 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+.. _platform_siliconlabsefm32:
+
+Platform ``siliconlabsefm32``
+=============================
+Silicon Labs EFM32 Gecko 32-bit microcontroller (MCU) family includes devices that offer flash memory configurations up to 256 kB, 32 kB of RAM and CPU speeds up to 48 MHz. Based on the powerful ARM Cortex-M core, the Gecko family features innovative low energy techniques, short wake-up time from energy saving modes and a wide selection of peripherals, making it ideal for battery operated applications and other systems requiring high performance and low-energy consumption.
+
+For more detailed information please visit `vendor site <http://www.silabs.com/products/mcu/32-bit/efm32-gecko/Pages/efm32-gecko.aspx>`_.
+
+.. contents::
+
+Packages
+--------
+
+.. list-table::
+    :header-rows:  1
+
+    * - Name
+      - Contents
+
+    * - ``framework-mbed``
+      - `mbed Framework <http://mbed.org>`_
+
+    * - ``toolchain-gccarmnoneeabi``
+      - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_, `GDB <http://www.gnu.org/software/gdb/>`_
+
+.. warning::
+    **Linux Users:** Don't forget to install "udev" rules file
+    `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
+
+    **Windows Users:** Please check that you have correctly installed USB driver
+    from board manufacturer
+
+
+
+Frameworks
+----------
+.. list-table::
+    :header-rows:  1
+
+    * - Name
+      - Description
+
+    * - :ref:`framework_mbed`
+      - The mbed framework The mbed SDK has been designed to provide enough hardware abstraction to be intuitive and concise, yet powerful enough to build complex projects. It is built on the low-level ARM CMSIS APIs, allowing you to code down to the metal if needed. In addition to RTOS, USB and Networking libraries, a cookbook of hundreds of reusable peripheral and module libraries have been built on top of the SDK by the mbed Developer Community.
+
+Boards
+------
+
+.. note::
+    * You can list pre-configured boards by :ref:`cmd_boards` command or
+      `PlatformIO Boards Explorer <http://platformio.org/#!/boards>`_
+    * For more detailed ``board`` information please scroll tables below by
+      horizontal.
+
+Silicon Labs
+~~~~~~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``efm32gg_stk3700``
+      - `Silicon Labs EFM32GG-STK3700 (Giant Gecko) <https://developer.mbed.org/platforms/EFM32-Giant-Gecko/>`_
+      - EFM32GG990F1024
+      - 48 MHz
+      - 1024 Kb
+      - 128 Kb
+
+    * - ``efm32hg_stk3400``
+      - `Silicon Labs SLSTK3400A USB-enabled (Happy Gecko) <https://developer.mbed.org/platforms/EFM32-Happy-Gecko/>`_
+      - EFM32HG322F64
+      - 24 MHz
+      - 64 Kb
+      - 8 Kb
+
+    * - ``efm32lg_stk3600``
+      - `Silicon Labs EFM32LG-STK3600 (Leopard Gecko) <https://developer.mbed.org/platforms/EFM32-Leopard-Gecko/>`_
+      - EFM32LG990F256
+      - 48 MHz
+      - 256 Kb
+      - 32 Kb
+
+    * - ``efm32wg_stk3800``
+      - `Silicon Labs EFM32WG-STK3800 (Wonder Gecko) <https://developer.mbed.org/platforms/EFM32-Wonder-Gecko/>`_
+      - EFM32WG990F256
+      - 48 MHz
+      - 256 Kb
+      - 32 Kb
+
+    * - ``efm32zg_stk3200``
+      - `Silicon Labs EFM32ZG-STK3200 (Zero Gecko) <https://developer.mbed.org/platforms/EFM32-Zero-Gecko/>`_
+      - EFM2ZG222F32
+      - 24 MHz
+      - 32 Kb
+      - 4 Kb

docs/platforms/ststm32.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _platform_ststm32:
 
 Platform ``ststm32``
@@ -42,6 +53,9 @@ Packages
     **Linux Users:** Don't forget to install "udev" rules file
     `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
 
+    **Windows Users:** Please check that you have correctly installed USB driver
+    from board manufacturer
+
 
 
 Frameworks
@@ -73,6 +87,40 @@ Boards
     * For more detailed ``board`` information please scroll tables below by
       horizontal.
 
+Armstrap
+~~~~~~~~
+
+.. list-table::
+    :header-rows:  1
+
+    * - Type ``board``
+      - Name
+      - Microcontroller
+      - Frequency
+      - Flash
+      - RAM
+
+    * - ``armstrap_eagle1024``
+      - `Armstrap Eagle 1024 <http://docs.armstrap.org/en/latest/hardware-overview.html>`_
+      - STM32F417VGT6
+      - 168 MHz
+      - 1024 Kb
+      - 192 Kb
+
+    * - ``armstrap_eagle2048``
+      - `Armstrap Eagle 2048 <http://docs.armstrap.org/en/latest/hardware-overview.html>`_
+      - STM32F427VIT6
+      - 168 MHz
+      - 2048 Kb
+      - 256 Kb
+
+    * - ``armstrap_eagle512``
+      - `Armstrap Eagle 512 <http://docs.armstrap.org/en/latest/hardware-overview.html>`_
+      - STM32F407VET6
+      - 168 MHz
+      - 512 Kb
+      - 192 Kb
+
 ST
 ~~
 
@@ -108,11 +156,11 @@ ST
       - 48 Kb
 
     * - ``disco_f334c8``
-      - `ST 32F3348DISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF260318>`_
+      - `ST 32F3348DISCOVERY <http://www.st.com/web/en/catalog/tools/PF260318>`_
       - STM32F334C8T6
       - 72 MHz
       - 64 Kb
-      - 16 Kb
+      - 12 Kb
 
     * - ``disco_f401vc``
       - `ST 32F401CDISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF259098>`_
@@ -135,6 +183,13 @@ ST
       - 2048 Kb
       - 256 Kb
 
+    * - ``disco_l053c8``
+      - `ST 32L0538DISCOVERY <http://www.st.com/web/en/catalog/tools/PF260319>`_
+      - STM32L053C8T6
+      - 32 MHz
+      - 64 Kb
+      - 8 Kb
+
     * - ``disco_l152rb``
       - `ST STM32LDISCOVERY <http://www.st.com/web/catalog/tools/FM116/SC959/SS1532/LN1848/PF258515>`_
       - STM32L152RBT6
@@ -212,6 +267,13 @@ ST
       - 512 Kb
       - 128 Kb
 
+    * - ``nucleo_f446re``
+      - `ST Nucleo F446RE <https://developer.mbed.org/platforms/ST-Nucleo-F446RE/>`_
+      - STM32F446RET6
+      - 180 MHz
+      - 512 Kb
+      - 128 Kb
+
     * - ``nucleo_l053r8``
       - `ST Nucleo L053R8 <https://developer.mbed.org/platforms/ST-Nucleo-L053R8/>`_
       - STM32L053R8T6

docs/platforms/teensy.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _platform_teensy:
 
 Platform ``teensy``
@@ -17,25 +28,31 @@ Packages
     * - Name
       - Contents
 
+    * - ``framework-arduinoteensy``
+      - `Arduino Wiring-based Framework <http://arduino.cc/en/Reference/HomePage>`_
+
+    * - ``tool-teensy``
+      - `Teensy Loader <https://www.pjrc.com/teensy/loader.html>`_
+
+    * - ``toolchain-gccarmnoneeabi``
+      - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_, `GDB <http://www.gnu.org/software/gdb/>`_
+
+    * - ``framework-mbed``
+      - `mbed Framework <http://mbed.org>`_
+
     * - ``toolchain-atmelavr``
       - `avr-gcc <https://gcc.gnu.org/wiki/avr-gcc>`_, `GDB <http://www.gnu.org/software/gdb/>`_, `AVaRICE <http://avarice.sourceforge.net/>`_, `SimulAVR <http://www.nongnu.org/simulavr/>`_
 
     * - ``ldscripts``
       - `Linker Scripts <https://sourceware.org/binutils/docs/ld/Scripts.html>`_
 
-    * - ``framework-arduinoteensy``
-      - `Arduino Wiring-based Framework <http://arduino.cc/en/Reference/HomePage>`_
-
-    * - ``toolchain-gccarmnoneeabi``
-      - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_, `GDB <http://www.gnu.org/software/gdb/>`_
-
-    * - ``tool-teensy``
-      - `Teensy Loader <https://www.pjrc.com/teensy/loader.html>`_
-
 .. warning::
     **Linux Users:** Don't forget to install "udev" rules file
     `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
 
+    **Windows Users:** Please check that you have correctly installed USB driver
+    from board manufacturer
+
 
 
 Frameworks
@@ -49,6 +66,9 @@ Frameworks
     * - :ref:`framework_arduino`
       - Arduino Framework allows writing cross-platform software to control devices attached to a wide range of Arduino boards to create all kinds of creative coding, interactive objects, spaces or physical experiences.
 
+    * - :ref:`framework_mbed`
+      - The mbed framework The mbed SDK has been designed to provide enough hardware abstraction to be intuitive and concise, yet powerful enough to build complex projects. It is built on the low-level ARM CMSIS APIs, allowing you to code down to the metal if needed. In addition to RTOS, USB and Networking libraries, a cookbook of hundreds of reusable peripheral and module libraries have been built on top of the SDK by the mbed Developer Community.
+
 Boards
 ------
 

docs/platforms/timsp430.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _platform_timsp430:
 
 Platform ``timsp430``
@@ -33,6 +44,9 @@ Packages
     **Linux Users:** Don't forget to install "udev" rules file
     `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
 
+    **Windows Users:** Please check that you have correctly installed USB driver
+    from board manufacturer
+
 
 
 Frameworks

docs/platforms/titiva.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _platform_titiva:
 
 Platform ``titiva``
@@ -36,6 +47,9 @@ Packages
     **Linux Users:** Don't forget to install "udev" rules file
     `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
 
+    **Windows Users:** Please check that you have correctly installed USB driver
+    from board manufacturer
+
 
 
 Frameworks

docs/platforms/windows_x86.rst

@@ -0,0 +1,32 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+.. _platform_windows_x86:
+
+Platform ``windows_x86``
+========================
+Windows x86 (32-bit) is a metafamily of graphical operating systems developed and marketed by Microsoft. Using host OS (Windows, Linux 32/64 or Mac OS X) you can build native application for Windows x86 platform.
+
+For more detailed information please visit `vendor site <http://platformio.org/#!/platforms/windows_x86>`_.
+
+.. contents::
+
+Packages
+--------
+
+.. list-table::
+    :header-rows:  1
+
+    * - Name
+      - Contents
+
+    * - ``toolchain-gccmingw32``
+      - `MinGW <http://www.mingw.org>`_

docs/projectconf.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _projectconf:
 
 Project Configuration File ``platformio.ini``
@@ -42,7 +53,7 @@ A default value is User's home directory:
 * Windows ``%HOMEPATH%\.platformio``
 
 This option can be overridden by global environment variable
-:ref:`envvar_PLATFORMIO_HOME_DIR`.
+:envvar:`PLATFORMIO_HOME_DIR`.
 
 .. _projectconf_pio_lib_dir:
 
@@ -55,7 +66,12 @@ This directory is used to store external libraries downloaded by
 A default value is ``%home_dir%/lib``.
 
 This option can be overridden by global environment variable
-:ref:`envvar_PLATFORMIO_LIB_DIR`.
+:envvar:`PLATFORMIO_LIB_DIR`.
+
+.. note::
+    You can put here your own/private libraries. The source code of each
+    library should be placed in separate directory. For example,
+    ``%lib_dir%/private_lib/[here are source files]``.
 
 .. _projectconf_pio_src_dir:
 
@@ -68,7 +84,7 @@ command.
 A default value is ``%project_dir%/src``.
 
 This option can be overridden by global environment variable
-:ref:`envvar_PLATFORMIO_SRC_DIR`.
+:envvar:`PLATFORMIO_SRC_DIR`.
 
 .. note::
     This option is useful for people who migrate from Arduino/Energia IDEs where
@@ -92,7 +108,7 @@ next build operation.
 A default value is ``%project_dir%/.pioenvs``.
 
 This option can be overridden by global environment variable
-:ref:`envvar_PLATFORMIO_ENVS_DIR`.
+:envvar:`PLATFORMIO_ENVS_DIR`.
 
 .. note::
     If you have any problems with building your Project environmets which
@@ -145,7 +161,8 @@ need to specify ``board_mcu``, ``board_f_cpu``, ``upload_protocol`` or
 ``upload_speed`` options. Just define a ``board`` type and *PlatformIO* will
 pre-fill options described above with appropriate values.
 
-You can find the ``board`` type in *Boards* section of each :ref:`platforms`.
+You can find the ``board`` type in *Boards* section of each :ref:`platforms` or
+using `PlatformIO Embedded Boards Explorer <http://platformio.org/#!/boards>`_.
 
 
 ``board_mcu``
@@ -198,20 +215,6 @@ A protocol that "uploader" tool uses to talk to the board.
 A connection speed (`baud rate <http://en.wikipedia.org/wiki/Baud>`_)
 which "uploader" tool uses when sending firmware to board.
 
-
-``targets``
-^^^^^^^^^^^
-
-A list with targets which will be processed by :ref:`cmd_run` command by
-default. You can enter more then one target separated with "space".
-
-When no targets are defined, *PlatformIO* will build only sources by default.
-
-.. note::
-    This option is useful to enable "auto-uploading" after building operation
-    (``targets = upload``).
-
-
 .. _projectconf_build_flags:
 
 ``build_flags``
@@ -226,10 +229,6 @@ processes:
     * - Format
       - Scope
       - Description
-    * - ``Wp,option``
-      - CPPFLAGS
-      - Bypass the compiler driver and pass *option* directly  through to the
-        preprocessor
     * - ``-D name``
       - CPPDEFINES
       - Predefine *name* as a macro, with definition 1.
@@ -241,6 +240,10 @@ processes:
       - CPPDEFINES
       - Cancel any previous definition of *name*, either built in or provided
         with a ``-D`` option.
+    * - ``-Wp,option``
+      - CPPFLAGS
+      - Bypass the compiler driver and pass *option* directly  through to the
+        preprocessor
     * - ``-Wall``
       - CCFLAGS
       - Turns on all optional warnings which are desirable for normal code.
@@ -254,10 +257,18 @@ processes:
       - CCFLAGS
       - Process *file* as if ``#include "file"`` appeared as the first line of
         the primary source file.
+    * - ``-Idir``
+      - CPPPATH
+      - Add the directory *dir* to the list of directories to be searched
+        for header files.
     * - ``-Wa,option``
       - ASFLAGS, CCFLAGS
       - Pass *option* as an option to the assembler. If *option* contains
         commas, it is split into multiple options at the commas.
+    * - ``-Wl,option``
+      - LINKFLAGS
+      - Pass *option* as an option to the linker. If *option* contains
+        commas, it is split into multiple options at the commas.
     * - ``-llibrary``
       - LIBS
       - Search the *library* named library when linking
@@ -265,21 +276,23 @@ processes:
       - LIBPATH
       - Add directory *dir* to the list of directories to be searched for
         ``-l``.
-    * - ``-Idir``
-      - CPPPATH
-      - Add the directory *dir* to the list of directories to be searched
-        for header files.
+
+This option can be set by global environment variable
+:envvar:`PLATFORMIO_BUILD_FLAGS`.
 
 Example:
 
 .. code-block::   ini
 
     [env:specific_defines]
-    build_flags = -O2 -Dfoo -Dbar=1
+    build_flags = -Dfoo -Dbar=1
 
     [env:specific_inclibs]
     build_flags = -I/opt/include -L/opt/lib -lfoo
 
+    [env:specific_ld_script]
+    build_flags = -Wl,-T/path/to/ld_script.ld
+
 
 For more detailed information about available flags/options go to:
 
@@ -297,30 +310,157 @@ For more detailed information about available flags/options go to:
 * `Options for Directory Search
   <https://gcc.gnu.org/onlinedocs/gcc/Directory-Options.html>`_
 
-.. _projectconf_srcbuild_flags:
+.. _projectconf_src_build_flags:
 
-``srcbuild_flags``
-^^^^^^^^^^^^^^^^^^
+``src_build_flags``
+^^^^^^^^^^^^^^^^^^^
 
-An option ``srcbuild_flags`` has the same behaviour like ``build_flags``
+An option ``src_build_flags`` has the same behaviour like ``build_flags``
 but will be applied only for the project source code from
 :ref:`projectconf_pio_src_dir` directory.
 
-This option can be overridden by global environment variable
-:ref:`envvar_PLATFORMIO_SRCBUILD_FLAGS`.
+This option can be set by global environment variable
+:envvar:`PLATFORMIO_SRC_BUILD_FLAGS`.
 
-``ignore_libs``
+.. _projectconf_src_filter:
+
+``src_filter``
+^^^^^^^^^^^^^^
+
+This option allows to specify which source files should be included/excluded
+from build process. Filter supports 2 templates:
+
+* ``+<PATH>`` include template
+* ``-<PATH>`` exclude template
+
+``PATH`` MAST BE related from :ref:`projectconf_pio_src_dir`. All patterns will
+be applied in theirs order.
+`GLOB Patterns <http://en.wikipedia.org/wiki/Glob_(programming)>`_ are allowed.
+
+By default, ``src_filter`` is predefined to
+``+<*> -<.git/> -<svn/> -<examples/>``, which means "includes ALL files, then
+exclude ``.git`` and ``svn`` repository folders and exclude ``examples`` folder.
+
+This option can be set by global environment variable
+:envvar:`PLATFORMIO_SRC_FILTER`.
+
+``lib_install``
 ^^^^^^^^^^^^^^^
 
-Specify libraries which should be ignored by ``Library Dependency Finder``
+Specify dependent libraries which should be installed before environment
+process. The only library IDs are allowed. Multiple libraries can be passed
+using comma ``,`` sign.
+
+You can obtain library IDs using :ref:`cmd_lib_search` command.
 
 Example:
 
-.. code-block::   ini
+.. code-block:: ini
+
+    [env:depends_on_some_libs]
+    lib_install = 1,13,19
+
+``lib_use``
+^^^^^^^^^^^
+
+Specify libraries which should be used by ``Library Dependency Finder (LDF)`` with
+the highest priority.
+
+Example:
+
+.. code-block:: ini
+
+    [env:libs_with_highest_priority]
+    lib_use = OneWire_ID1,SPI
+
+``lib_ignore``
+^^^^^^^^^^^^^^
+
+Specify libraries which should be ignored by ``Library Dependency Finder (LDF)``
+
+Example:
+
+.. code-block:: ini
 
     [env:ignore_some_libs]
-    ignore_libs = SPI,EngduinoV3_ID123
+    lib_ignore = SPI,EngduinoV3_ID123
 
+``lib_dfcyclic``
+^^^^^^^^^^^^^^^^
+
+Control cyclic (recursive) behaviour for ``Library Dependency Finder (LDF)``.
+By default, this option is turned OFF (``lib_dfcyclic=False``) and means, that
+``LDF`` will find only libraries which are included in source files from the
+project :ref:`projectconf_pio_src_dir`.
+
+If you want to enable cyclic (recursive, nested) search, please set this option
+to ``True``. Founded library will be treated like a new source files and
+``LDF`` will search dependencies for it.
+
+Example:
+
+.. code-block:: ini
+
+    [env:libs_with_enabled_ldf_cyclic]
+    lib_dfcyclic = True
+
+.. _projectconf_extra_script:
+
+``extra_script``
+^^^^^^^^^^^^^^^^
+
+Allows to launch extra script using `SCons <http://www.scons.org>`_ software
+construction tool. For more details please follow to "Construction Environments"
+section of
+`SCons documentation <http://www.scons.org/doc/production/HTML/scons-user.html#chap-environments>`_.
+
+This option can be set by global environment variable
+:envvar:`PLATFORMIO_EXTRA_SCRIPT`.
+
+Example, specify own upload command for :ref:`platform_atmelavr`:
+
+``platformio.ini``:
+
+.. code-block:: ini
+
+    [env:env_with_specific_extra_script]
+    platform = atmelavr
+    extra_script = /path/to/extra_script.py
+
+``extra_script.py``:
+
+.. code-block:: python
+
+    from SCons.Script import DefaultEnvironment
+
+    env = DefaultEnvironment()
+
+    env.Replace(UPLOADHEXCMD='"$UPLOADER" --uploader --flags')
+
+    # uncomment line below to see environment variables
+    # print env.Dump()
+
+See built-in examples of `PlatformIO build scripts <https://github.com/platformio/platformio/tree/develop/platformio/builder/scripts>`_.
+
+``targets``
+^^^^^^^^^^^
+
+A list with targets which will be processed by :ref:`cmd_run` command by
+default. You can enter more then one target separated with "space". Which
+targets are supported is described in :option:`platformio run --target`.
+
+**Tip!** You can use these targets like an option to
+:option:`platformio run --target` command. For example:
+
+.. code-block:: bash
+
+    # clean project
+    platformio run -t clean
+
+    # dump curent build environment
+    platformio run --target envdump
+
+When no targets are defined, *PlatformIO* will build only sources by default.
 
 .. _projectconf_examples:
 
@@ -346,39 +486,7 @@ Examples
     targets = upload
 
 
-2. :ref:`platform_atmelavr`: Microduino Core (ATmega168P, 3.3V) board with
-   auto pre-configured ``board_*`` and ``upload_*`` options (use only
-   ``board`` option) and Arduino Wiring-based Framework
-
-.. code-block:: ini
-
-    [env:atmelavr_microduino_core_board]
-    platform = atmelavr
-    framework = arduino
-    board = 168pa8m
-
-    # enable auto-uploading
-    targets = upload
-
-
-3. :ref:`platform_atmelavr`: Raspduino board with
-   auto pre-configured ``board_*`` and ``upload_*`` options (use only
-   ``board`` option) and Arduino Wiring-based Framework
-
-.. code-block:: ini
-
-    [env:atmelavr_raspduino_board]
-    platform = atmelavr
-    framework = arduino
-    board = raspduino
-
-    upload_port = /dev/ttyS0
-
-    # enable auto-uploading
-    targets = upload
-
-
-4. :ref:`platform_atmelavr`: Embedded board that is based on ATmega168 MCU with
+2. :ref:`platform_atmelavr`: Embedded board that is based on ATmega168 MCU with
    "arduino" bootloader
 
 .. code-block:: ini
@@ -398,7 +506,7 @@ Examples
     targets = upload
 
 
-5. Upload firmware via USB programmer (USBasp) to :ref:`platform_atmelavr`
+3. Upload firmware via USB programmer (USBasp) to :ref:`platform_atmelavr`
    microcontrollers
 
 .. code-block:: ini
@@ -409,42 +517,25 @@ Examples
     board = pro8MHzatmega328
     upload_protocol = usbasp -B5
 
+Then upload firmware using :option:`platformio run --target program`
 
-6. :ref:`platform_timsp430`: TI MSP430G2553 LaunchPad with auto pre-configured
-   ``board_*`` and ``upload_*`` options (use only ``board`` option) and Energia
-   Wiring-based Framework
+
+4. :ref:`platform_ststm32`: Upload firmware using GDB script ``upload.gdb``,
+   `issue #175 <https://github.com/platformio/platformio/issues/175>`_
 
 .. code-block:: ini
 
-    [env:timsp430_g2553_launchpad]
-    platform = timsp430
-    framework = energia
-    board = lpmsp430g2553
+    [env:st_via_gdb]
+    platform = ststm32
+    board = armstrap_eagle512
+    upload_protocol = gdb
 
-
-7. :ref:`platform_timsp430`: Embedded board that is based on MSP430G2553 MCU
+5. :ref:`platform_ststm32`: Upload firmware using ST-Link instead mbed's media
+   disk
 
 .. code-block:: ini
 
-    [env:timsp430_g2553_board]
-    platform = timsp430
-    board_mcu = msp430g2553
-    board_f_cpu = 16000000L
-
-    upload_protocol = rf2500
-
-    # enable auto-uploading
-    targets = upload
-
-
-8. :ref:`platform_titiva`: TI Tiva C ARM Series TM4C123G LaunchPad with auto
-   pre-configured ``board_*`` and ``upload_*`` options (use only ``board``
-   option) and Energia Wiring-based Framework
-
-.. code-block:: ini
-
-    [env:titiva_tm4c1230c3pm_launchpad]
-    platform = titiva
-    framework = energia
-    board = lptm4c1230c3pm
-
+    [env:stlink_for_mbed]
+    platform = ststm32
+    board = disco_f100rb
+    upload_protocol = stlink

docs/quickstart.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _quickstart:
 
 Quickstart
@@ -9,8 +20,8 @@ Quickstart
 
 1. :ref:`Install PlatformIO <installation>`.
 
-2. Find board ``type`` on this :ref:`Embedded Boards <platforms>` page or
-   via :ref:`cmd_boards` command.
+2. Find board ``type`` using `Embedded Boards Explorer <http://platformio.org/#!/boards>`_
+   or via :ref:`cmd_boards` command.
 
 3. Initialize new PlatformIO based project via :ref:`cmd_init` command with the
    pre-configured environments for your boards:
@@ -28,8 +39,8 @@ Quickstart
 
     The next files/directories will be created in ***
     platformio.ini - Project Configuration File. |-> PLEASE EDIT ME <-|
-    src - Put your source code here
-    lib - Put here project specific or 3-rd party libraries
+    src - Put your source files here
+    lib - Put here project specific (private) libraries
     Do you want to continue? [y/N]: y
     Project has been successfully initialized!
     Useful commands:
@@ -37,7 +48,7 @@ Quickstart
     `platformio run --target upload` or `platformio run -t upload` - upload firmware to embedded board
     `platformio run --target clean` - clean project (remove compiled files)
 
-Put your source code ``*.h, *.c, *.cpp or *.ino`` files to ``src`` directory.
+Put your source files ``*.h, *.c, *.cpp or *.ino`` to ``src`` directory.
 
 4. Process the project's environments.
 

docs/userguide/cmd_boards.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _cmd_boards:
 
 platformio boards

docs/userguide/cmd_ci.rst

@@ -0,0 +1,121 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+.. _cmd_ci:
+
+platformio ci
+=============
+
+.. contents::
+
+Usage
+-----
+
+.. code-block:: bash
+
+    platformio ci [OPTIONS] [SRC]
+
+
+Description
+-----------
+
+:ref:`cmd_ci` command is conceived of as "hot key" for building project with
+arbitrary source code structure. In a nutshell, using ``SRC`` and
+:option:`platformio ci --lib` contents PlatformIO initialises via
+:ref:`cmd_init` new project in :option:`platformio ci --build-dir`
+with the build environments (using :option:`platformio ci --board` or
+:option:`platformio ci --project-conf`) and processes them via :ref:`cmd_run`
+command.
+
+For more details as for integration with the popular Continuous Integration
+Systems please follow to :ref:`ci` page.
+
+.. note::
+    :ref:`cmd_ci` command accepts **multiple** ``SRC`` arguments,
+    :option:`platformio ci --lib` and :option:`platformio ci --exclude` options
+    which can be a path to directory, file or
+    `Glob Pattern <http://en.wikipedia.org/wiki/Glob_(programming)>`_.
+
+.. note::
+    You can omit ``SRC`` argument and set path (multiple paths are allowed
+    denoting with ``:``) to
+    ``PLATFORMIO_CI_SRC`` `Environment variable <http://en.wikipedia.org/wiki/Environment_variable>`_
+
+Options
+-------
+
+.. program:: platformio ci
+
+.. option::
+    -l, --lib
+
+Source code which will be copied to ``%build_dir%/lib`` directly.
+
+If :option:`platformio ci --lib` is a path to file (not to directory), then
+PlatformIO will create temporary directory within ``%build_dir%/lib`` and copy
+the rest files into it.
+
+
+.. option::
+    --exclude
+
+Exclude directories and/-or files from :option:`platformio ci --build-dir`. The
+path must be relative to PlatformIO project within
+:option:`platformio ci --build-dir`.
+
+For example, exclude from project ``src`` directory:
+
+* ``examples`` folder
+* ``*.h`` files from ``foo`` folder
+
+.. code-block:: bash
+
+    platformio ci --exclude=src/examples --exclude=src/foo/*.h [SRC]
+
+.. option::
+    -b, --board
+
+Build project with automatically pre-generated environments based on board
+settings.
+
+For more details please look into :option:`platformio init --board`.
+
+.. option::
+    --build-dir
+
+Path to directory where PlatformIO will initialise new project. By default it's
+temporary directory within your operation system.
+
+.. note::
+
+    This directory will be removed at the end of build process. If you want to
+    keep it, please use :option:`platformio ci --keep-build-dir`.
+
+.. option::
+    --keep-build-dir
+
+Don't remove :option:`platformio ci --build-dir` after build process.
+
+.. option::
+    --project-conf
+
+Buid project using pre-configured :ref:`projectconf`.
+
+.. option::
+    -v, --verbose
+
+Shows details about the results of processing environments. More details
+:option:`platformio run --verbose`
+
+Examples
+--------
+
+For the examples please follow to :ref:`ci` page.

docs/userguide/cmd_init.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _cmd_init:
 
 platformio init
@@ -22,20 +33,26 @@ Initialize new PlatformIO based project.
 This command will create:
 
 * :ref:`projectconf`
-* ``src`` - a source directory. Put your source code here
-* ``lib`` - a directory for the project specific libraries. PlatformIO will
-  compile them to static libraries and link to executable file
+* ``src`` - a source directory. Put your source files here
+* ``lib`` - a directory for the project specific (private) libraries.
+  PlatformIO will compile them to static libraries and link to executable file
+
+.. note::
+    The source code of each library should be placed in separate directory.
+    For example, ``lib/private_lib/[here are source files]``.
 
 Options
 -------
 
+.. program:: platformio init
+
 .. option::
-    --project-dir, -d
+    -d, --project-dir
 
 A path to the directory where *PlatformIO* will initialise new project.
 
 .. option::
-    --board, -b
+    -b, --board
 
 If you specify board ``type`` (you can pass multiple ``--board`` options), then
 *PlatformIO* will automatically generate environment for :ref:`projectconf` and
@@ -47,13 +64,32 @@ pre-fill these data:
 
 The full list with pre-configured boards is available here :ref:`platforms`.
 
+.. option::
+    --ide
+
+Initialise PlatformIO project for the specified IDE which can be imported later
+via "Import Project" functionality.
+
+A list with supported IDE is available within ``platformio init --help`` command.
+Also, please look into :ref:`ide` page.
+
 .. option::
     --disable-auto-uploading
 
-If you initialise project with the specified ``--board``, then *PlatformIO*
+If you initialise project with the specified
+:option:`platformio init --board`, then *PlatformIO*
 will create environment with enabled firmware auto-uploading. This option
 allows you to disable firmware auto-uploading by default.
 
+.. option::
+    --env-prefix
+
+An environment prefix which will be used with pair in board type.
+For example, the default environment name for ``teensy_31`` board will
+be ``[env:teensy_31]``.
+
+
+
 Examples
 --------
 
@@ -69,8 +105,8 @@ Examples
 
     The next files/directories will be created in ***
     platformio.ini - Project Configuration File. |-> PLEASE EDIT ME <-|
-    src - Put your source code here
-    lib - Put here project specific or 3-rd party libraries
+    src - Put your source files here
+    lib - Put here project specific (private) libraries
     Do you want to continue? [y/N]: y
     Project has been successfully initialized!
     Useful commands:
@@ -87,8 +123,8 @@ Examples
 
     The next files/directories will be created in ***
      platformio.ini - Project Configuration File. |-> PLEASE EDIT ME <-|
-    src - Put your source code here
-    lib - Put here project specific or 3-rd party libraries
+    src - Put your source files here
+    lib - Put here project specific (private) libraries
     Do you want to continue? [y/N]: y
     Project has been successfully initialized!
     Useful commands:
@@ -111,8 +147,8 @@ Examples
 
     The next files/directories will be created in ***
     platformio.ini - Project Configuration File. |-> PLEASE EDIT ME <-|
-    src - Put your source code here
-    lib - Put here project specific or 3-rd party libraries
+    src - Put your source files here
+    lib - Put here project specific (private) libraries
     Do you want to continue? [y/N]: y
     Project has been successfully initialized!
     Useful commands:

docs/userguide/cmd_run.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _cmd_run:
 
 platformio run
@@ -22,6 +33,8 @@ Process environments which are defined in :ref:`projectconf` file
 Options
 -------
 
+.. program:: platformio run
+
 .. option::
     -e, --environment
 
@@ -31,7 +44,17 @@ Process specified environments
 .. option::
     -t, --target
 
-Process specified targets
+Process specified targets.
+
+Pre-built targets:
+
+* ``clean`` delete compiled object files, libraries and firmware/program binaries
+* ``upload`` firmware "auto-uploading" for embedded platforms
+* ``program`` firmware "auto-uploading" for embedded platforms using external
+  programmer (available only for :ref:`platform_atmelavr`)
+* ``uploadlazy`` upload existing firmware without project rebuilding
+* ``envdump`` dump current build environment
+* ``size`` print the size of the sections in a firmware/program
 
 .. option::
     --upload-port
@@ -39,6 +62,33 @@ Process specified targets
 Upload port of embedded board. To print all available ports use
 :ref:`cmd_serialports` command
 
+.. option::
+    -d, --project-dir
+
+Specify the path to project directory. By default, ``--project-dir`` is equal
+to current working directory (``CWD``).
+
+.. option::
+    -v, --verbose
+
+Shows details about the results of processing environments. Each instance of
+``--verbose`` on the command line increases the verbosity level by one, so if
+you need more details on the output, specify it twice.
+
+There 3 levels of verbosity:
+
+1. ``-v`` - output errors only
+2. ``-vv`` - output errors and warnings
+3. ``-vvv`` - output errors, warnings and additional information
+
+By default, verbosity level is set to 3 (maximum information).
+
+.. option::
+    --disable-auto-clean
+
+Disable auto-clean of :ref:`projectconf_pio_envs_dir` when :ref:`projectconf`
+or :ref:`projectconf_pio_src_dir` (project structure) have been modified.
+
 Examples
 --------
 

docs/userguide/cmd_serialports.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _cmd_serialports:
 
 platformio serialports
@@ -24,6 +35,8 @@ List available `Serial Ports <http://en.wikipedia.org/wiki/Serial_port>`_
 Options
 ~~~~~~~
 
+.. program:: platformio serialports list
+
 .. option::
     --json-output
 
@@ -99,6 +112,8 @@ To control *monitor* please use these "hot keys":
 Options
 ~~~~~~~
 
+.. program:: platformio serialports monitor
+
 .. option::
     -p, --port
 
@@ -136,30 +151,41 @@ Set initial ``RTS`` line state, default ``0``
 Set initial ``DTR`` line state, default ``0``
 
 .. option::
-    --echo
+    --encoding
 
-Enable local echo, default ``Off``
+Set the encoding for the serial port (e.g. ``hexlify``, ``Latin1``, ``UTF-8``),
+default ``UTF-8``.
+
+**NEW**: Available in Miniterm/PySerial 3.0
 
 .. option::
-    --cr
+    -f, --filter
 
-Do not send ``CR+LF``, send ``R`` only, default ``Off``
+Add text transformation. Available filters:
+
+* ``colorize`` Apply different colors for received and echo
+* ``debug`` Print what is sent and received
+* ``default`` Remove typical terminal control codes from input
+* ``direct`` Do-nothing: forward all data unchanged
+* ``nocontrol`` Remove all control codes, incl. CR+LF
+* ``printable`` Show decimal code for all non-ASCII characters and replace
+  most control codes
+
+**NEW**: Available in Miniterm/PySerial 3.0
 
 .. option::
-    --lf
+    --eol
 
-Do not send ``CR+LF``, send ``LF`` only, default ``Off``
+End of line mode (``CR``, ``LF`` or ``CRLF``), default ``CRLF``
+
+**NEW**: Available in Miniterm/PySerial 3.0
 
 .. option::
-    -d, --debug
+    --raw
 
-Debug received data (escape non-printable chars). ``--debug`` can be given
-multiple times:
+Do not apply any encodings/transformations
 
-0. just print what is received
-1. escape non-printable characters, do newlines as unusual
-2. escape non-printable characters, newlines too
-3. hex dump everything
+**NEW**: Available in Miniterm/PySerial 3.0
 
 .. option::
     --exit-char
@@ -178,6 +204,43 @@ default ``0x14``
 
 Diagnostics: suppress non-error messages, default ``Off``
 
+
+.. option::
+    --echo
+
+Enable local echo, default ``Off``
+
+**REMOVED**: Is not available in Miniterm/PySerial 3.0
+
+.. option::
+    --cr
+
+Do not send ``CR+LF``, send ``R`` only, default ``Off``
+
+**REMOVED**: Is not available in Miniterm/PySerial 3.0
+
+.. option::
+    --lf
+
+Do not send ``CR+LF``, send ``LF`` only, default ``Off``
+
+**REMOVED**: Is not available in Miniterm/PySerial 3.0
+
+.. option::
+    -d, --debug
+
+Debug received data (escape non-printable chars). ``--debug`` can be given
+multiple times:
+
+0. just print what is received
+1. escape non-printable characters, do newlines as unusual
+2. escape non-printable characters, newlines too
+3. hex dump everything
+
+**REMOVED**: Is not available in Miniterm/PySerial 3.0.
+See :option:`platformio serialports monitor --encoding` and
+:option:`platformio serialports monitor --filter` options.
+
 Examples
 ~~~~~~~~
 
@@ -197,21 +260,17 @@ Examples
       --rts [0|1]           Set initial RTS line state, default=0
       --dtr [0|1]           Set initial DTR line state, default=0
       --echo                Enable local echo, default=Off
-      --cr                  Do not send CR+LF, send CR only, default=Off
-      --lf                  Do not send CR+LF, send LF only, default=Off
-      -d, --debug           Debug received data (escape non-printable chars)
-                            --debug can be given multiple times:
-                            0: just print what is received
-                            1: escape non-printable characters, do newlines as
-                               unusual
-                            2: escape non-printable characters, newlines too
-                            3: hex dump everything
+      --encoding TEXT       Set the encoding for the serial port (e.g. hexlify,
+                            Latin1, UTF-8), default: UTF-8
+      -f, --filter TEXT     Add text transformation
+      --eol [CR|LF|CRLF]    End of line mode, default=CRLF
+      --raw                 Do not apply any encodings/transformations
       --exit-char INTEGER   ASCII code of special character that is used to exit
-                            the application, default=0x1d
+                            the application, default=29 (DEC)
       --menu-char INTEGER   ASCII code of special character that is used to
-                            control miniterm (menu), default=0x14
+                            control miniterm (menu), default=20 (DEC)
       --quiet               Diagnostics: suppress non-error messages, default=Off
-      --help                Show this message and exit.
+      -h, --help            Show this message and exit.
 
 2. Communicate with serial device and print help inside terminal
 

docs/userguide/cmd_settings.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _cmd_settings:
 
 platformio settings

docs/userguide/cmd_show.rst

@@ -1,45 +0,0 @@
-.. _cmd_show:
-
-platformio show
-===============
-
-.. contents::
-
-Usage
------
-
-.. code-block:: bash
-
-    platformio show PLATFORM
-
-
-Description
------------
-
-Show details about the installed :ref:`Platforms <platforms>`
-
-
-Examples
---------
-
-.. code-block:: bash
-
-    $ platformio show atmelavr
-    atmelavr    - An embedded platform for Atmel AVR microcontrollers (with Arduino Framework)
-    ----------
-    Package: toolchain-atmelavr
-    Alias: toolchain
-    Version: 1
-    Installed: 2014-12-13 23:58:48
-    ----------
-    Package: tool-avrdude
-    Version: 2
-    Installed: 2015-02-13 22:23:17
-    ----------
-    Package: framework-arduinoavr
-    Version: 12
-    Installed: 2015-02-23 20:57:40
-    ----------
-    Package: tool-micronucleus
-    Version: 1
-    Installed: 2015-02-23 21:20:14

docs/userguide/cmd_uninstall.rst

@@ -1,31 +0,0 @@
-.. _cmd_uninstall:
-
-platformio uninstall
-====================
-
-.. contents::
-
-Usage
------
-
-.. code-block:: bash
-
-    platformio uninstall PLATFORM
-
-
-Description
------------
-
-Uninstall specified :ref:`Platforms <platforms>`
-
-
-Examples
---------
-
-.. code-block:: bash
-
-    $ platformio uninstall timsp430
-    Uninstalling toolchain-timsp430 package:        [OK]
-    Uninstalling tool-mspdebug package:             [OK]
-    Uninstalling framework-energiamsp430 package:   [OK]
-    The platform 'timsp430' has been successfully uninstalled!

docs/userguide/cmd_update.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _cmd_update:
 
 platformio update
@@ -16,7 +27,8 @@ Usage
 Description
 -----------
 
-Check or update installed :ref:`Platforms <platforms>`
+Check or update installed :ref:`Platforms <platforms>` and
+:ref:`Libraries <librarymanager>`
 
 
 Examples

docs/userguide/cmd_upgrade.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _cmd_upgrade:
 
 platformio upgrade

docs/userguide/index.rst

@@ -1,9 +1,48 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _userguide:
 
 User Guide
 ==========
 
-To print all available commands and options use:
+.. contents::
+
+Usage
+-----
+
+.. code-block:: bash
+
+    platformio [OPTIONS] COMMAND
+
+Options
+-------
+
+.. program:: platformio
+
+.. option::
+    --force, -f
+
+Force to accept any confirmation prompts. This option allows to avoid an issue
+with :ref:`faq_troubleshooting_pioblocksprompt`
+
+.. option::
+    --version
+
+Show the version of PlatformIO
+
+.. option::
+    --help, -h
+
+Show help for the available options and commands
 
 .. code-block:: bash
 
@@ -11,19 +50,19 @@ To print all available commands and options use:
     $ platformio COMMAND --help
 
 
+Commands
+--------
+
 .. toctree::
     :maxdepth: 2
 
     cmd_boards
+    cmd_ci
     cmd_init
-    cmd_install
     platformio lib <lib/index>
-    cmd_list
+    platformio platforms <platforms/index>
     cmd_run
-    cmd_search
     cmd_serialports
     cmd_settings
-    cmd_show
-    cmd_uninstall
     cmd_update
     cmd_upgrade

docs/userguide/lib/cmd_install.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _cmd_lib_install:
 
 platformio lib install
@@ -22,6 +33,8 @@ Install new library  by specified
 Options
 -------
 
+.. program:: platformio lib install
+
 .. option::
     -v, --version
 

docs/userguide/lib/cmd_list.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _cmd_lib_list:
 
 platformio lib list
@@ -21,6 +32,8 @@ List installed libraries
 Options
 ~~~~~~~
 
+.. program:: platformio lib list
+
 .. option::
     --json-output
 

docs/userguide/lib/cmd_register.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _cmd_lib_register:
 
 platformio lib register

docs/userguide/lib/cmd_search.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _cmd_lib_search:
 
 platformio lib search
@@ -61,6 +72,8 @@ For more detail information please go to
 Options
 -------
 
+.. program:: platformio lib search
+
 .. option::
     -a, --author
 

docs/userguide/lib/cmd_show.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _cmd_lib_show:
 
 platformio lib show

docs/userguide/lib/cmd_uninstall.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _cmd_lib_uninstall:
 
 platformio lib uninstall

docs/userguide/lib/cmd_update.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _cmd_lib_update:
 
 platformio lib update
@@ -10,7 +21,7 @@ Usage
 
 .. code-block:: bash
 
-    platformio lib update
+    platformio lib update [LIBRARY_ID]
 
 
 Description
@@ -22,6 +33,8 @@ Check or update installed libraries
 Examples
 --------
 
+1. Update all installed libraries
+
 .. code-block:: bash
 
     $ platformio lib update
@@ -36,8 +49,23 @@ Examples
     # Updating  [ 13 ] Adafruit-GFX library:
     # Versions: Current=a9e5bc4707, Latest=a9e5bc4707 	 [Up-to-date]
     # Updating  [ 1 ] OneWire library:
-    # Versions: Current=2.2, Latest=2.2 	 [Up-to-date]
+    # Versions: Current=2.2, Latest=2.2 	             [Up-to-date]
     # Updating  [ 4 ] IRremote library:
     # Versions: Current=f2dafe5030, Latest=f2dafe5030 	 [Up-to-date]
     # Updating  [ 14 ] Adafruit-9DOF-Unified library:
     # Versions: Current=b2f07242ac, Latest=b2f07242ac 	 [Up-to-date]
+
+2. Update specified libraries
+
+.. code-block:: bash
+
+    $ platformio lib update 1 59
+    # Updating  [ 1 ] OneWire library:
+    # Versions: Current=2.2, Latest=2.2 	             [Up-to-date]
+    # Updating [ 59 ] USB-Host-Shield-20 library:
+    # Versions: Current=fcab83dcb3, Latest=c61f9ce1c2 	 [Out-of-date]
+    # The library #59 'USB-Host-Shield-20' has been successfully uninstalled!
+    # Installing library [ 59 ]:
+    # Downloading  [####################################]  100%
+    # Unpacking  [####################################]  100%
+    # The library #59 'USB-Host-Shield-20' has been successfully installed!

docs/userguide/lib/index.rst

@@ -1,3 +1,14 @@
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
 .. _userguide_lib:
 
 Library Manager

docs/userguide/platforms/cmd_install.rst

@@ -1,7 +1,18 @@
-.. _cmd_install:
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
 
-platformio install
-==================
+.. _cmd_platforms_install:
+
+platformio platforms install
+============================
 
 .. contents::
 
@@ -10,7 +21,7 @@ Usage
 
 .. code-block:: bash
 
-    platformio install [OPTIONS] [PLATFORMS]
+    platformio platforms install [OPTIONS] [PLATFORMS]
 
 
 Description
@@ -27,6 +38,8 @@ There are several predefined aliases for packages, such as:
 Options
 -------
 
+.. program:: platformio platforms install
+
 .. option::
     --with-package
 
@@ -50,7 +63,7 @@ Examples
 
 .. code-block:: bash
 
-    $ platformio install timsp430
+    $ platformio platforms install timsp430
     Installing toolchain-timsp430 package:
     Downloading  [####################################]  100%
     Unpacking  [####################################]  100%
@@ -68,7 +81,7 @@ Examples
 
 .. code-block:: bash
 
-    $ platformio install timsp430 --skip-default-package --with-package=uploader
+    $ platformio platforms install timsp430 --skip-default-package --with-package=uploader
     Installing tool-mspdebug package:
     Downloading  [####################################]  100%
     Unpacking  [####################################]  100%

docs/userguide/platforms/cmd_list.rst

@@ -1,7 +1,18 @@
-.. _cmd_list:
+..  Copyright 2014-2015 Ivan Kravets <me@ikravets.com>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
 
-platformio list
-===============
+.. _cmd_platforms_list:
+
+platformio platforms list
+=========================
 
 .. contents::
 
@@ -10,7 +21,7 @@ Usage
 
 .. code-block:: bash
 
-    platformio list [OPTIONS]
+    platformio platforms list [OPTIONS]
 
 
 Description
@@ -21,6 +32,8 @@ List installed :ref:`Platforms <platforms>`
 Options
 ~~~~~~~
 
+.. program:: platformio platforms list
+
 .. option::
     --json-output
 
@@ -31,7 +44,7 @@ Examples
 
 .. code-block:: bash
 
-    $ platformio list
+    $ platformio platforms list
     atmelavr    with packages: toolchain-atmelavr, tool-avrdude, framework-arduinoavr, tool-micronucleus
     atmelsam    with packages: framework-arduinosam, ldscripts, toolchain-gccarmnoneeabi, tool-bossac
     freescalekinetis with packages: framework-mbed, toolchain-gccarmnoneeabi