Merge branch 'release/v2.5.0'

Slight grammar/wording tweaks

.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,bottle
+known_third_party=bottle,click,lockfile,pytest,requests,serial,SCons

.pylintrc

@@ -1,29 +1,9 @@
-[MASTER]
-
-# Specify a configuration file.
-#rcfile=
-
-# Python code to execute, usually for sys.path manipulation such as
-# pygtk.require().
-#init-hook=
-
-# Profiled execution.
-profile=no
-
-# Add files or directories to the blacklist. They should be base names, not
-# paths.
-ignore=CVS
-
-# Pickle collected data for later comparisons.
-persistent=yes
-
-# List of plugins (as comma separated values of python modules names) to load,
-# usually to register additional checkers.
-load-plugins=
-
-
 [MESSAGES CONTROL]
 
+# Only show warnings with the listed confidence levels. Leave empty to show
+# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
+confidence=
+
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
 # multiple time. See also the "--disable" option for examples.
@@ -38,244 +18,6 @@ load-plugins=
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
-disable=C0103,C0111,E0611,F0401,I0011,R0801,R0903,R0922
+# disable=import-star-module-level,old-octal-literal,oct-method,print-statement,unpacking-in-except,parameter-unpacking,backtick,old-raise-syntax,old-ne-operator,long-suffix,dict-view-method,dict-iter-method,metaclass-assignment,next-method-called,raising-string,indexing-exception,raw_input-builtin,long-builtin,file-builtin,execfile-builtin,coerce-builtin,cmp-builtin,buffer-builtin,basestring-builtin,apply-builtin,filter-builtin-not-iterating,using-cmp-argument,useless-suppression,range-builtin-not-iterating,suppressed-message,no-absolute-import,old-division,cmp-method,reload-builtin,zip-builtin-not-iterating,intern-builtin,unichr-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,input-builtin,round-builtin,hex-method,nonzero-method,map-builtin-not-iterating
 
-
-[REPORTS]
-
-# Set the output format. Available formats are text, parseable, colorized, msvs
-# (visual studio) and html. You can also give a reporter class, eg
-# mypackage.mymodule.MyReporterClass.
-output-format=text
-
-# Put messages in a separate file for each module / package specified on the
-# command line instead of printing them on stdout. Reports (if any) will be
-# written in a file name "pylint_global.[txt|html]".
-files-output=no
-
-# Tells whether to display a full report or only the messages
-reports=yes
-
-# Python expression which should return a note less than 10 (10 is the highest
-# note). You have access to the variables errors warning, statement which
-# respectively contain the number of errors / warnings messages and the total
-# number of statements analyzed. This is used by the global evaluation report
-# (RP0004).
-evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
-
-# Add a comment according to your evaluation note. This is used by the global
-# evaluation report (RP0004).
-comment=no
-
-# Template used to display messages. This is a python new-style format string
-# used to format the message information. See doc for all details
-#msg-template=
-msg-template={path}:{line}: [{msg_id}({symbol}), {obj}] {msg}
-
-
-[BASIC]
-
-# Required attributes for module, separated by a comma
-required-attributes=
-
-# List of builtins function names that should not be used, separated by a comma
-bad-functions=map,filter,apply,input
-
-# Regular expression which should only match correct module names
-module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
-
-# Regular expression which should only match correct module level names
-const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
-
-# Regular expression which should only match correct class names
-class-rgx=[A-Z_][a-zA-Z0-9]+$
-
-# Regular expression which should only match correct function names
-function-rgx=[a-z_][a-z0-9_]{2,30}$
-
-# Regular expression which should only match correct method names
-method-rgx=[a-z_][a-z0-9_]{2,30}$
-
-# Regular expression which should only match correct instance attribute names
-attr-rgx=[a-z_][a-z0-9_]{2,30}$
-
-# Regular expression which should only match correct argument names
-argument-rgx=[a-z_][a-z0-9_]{2,30}$
-
-# Regular expression which should only match correct variable names
-variable-rgx=[a-z_][a-z0-9_]{2,30}$
-
-# Regular expression which should only match correct attribute names in class
-# bodies
-class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
-
-# Regular expression which should only match correct list comprehension /
-# generator expression variable names
-inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
-
-# Good variable names which should always be accepted, separated by a comma
-good-names=i,j,k,ex,Run,_
-
-# Bad variable names which should always be refused, separated by a comma
-bad-names=foo,bar,baz,toto,tutu,tata
-
-# Regular expression which should only match function or class names that do
-# not require a docstring.
-no-docstring-rgx=__.*__
-
-# Minimum line length for functions/classes that require docstrings, shorter
-# ones are exempt.
-docstring-min-length=-1
-
-
-[FORMAT]
-
-# Maximum number of characters on a single line.
-max-line-length=80
-
-# Regexp for a line that is allowed to be longer than the limit.
-ignore-long-lines=^\s*(# )?<?https?://\S+>?$
-
-# Allow the body of an if to be on the same line as the test if there is no
-# else.
-single-line-if-stmt=no
-
-# List of optional constructs for which whitespace checking is disabled
-no-space-check=trailing-comma,dict-separator
-
-# Maximum number of lines in a module
-max-module-lines=1000
-
-# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
-# tab).
-indent-string='    '
-
-
-[MISCELLANEOUS]
-
-# List of note tags to take in consideration, separated by a comma.
-notes=FIXME,XXX,TODO
-
-
-[SIMILARITIES]
-
-# Minimum lines number of a similarity.
-min-similarity-lines=4
-
-# Ignore comments when computing similarities.
-ignore-comments=yes
-
-# Ignore docstrings when computing similarities.
-ignore-docstrings=yes
-
-# Ignore imports when computing similarities.
-ignore-imports=no
-
-
-[TYPECHECK]
-
-# Tells whether missing members accessed in mixin class should be ignored. A
-# mixin class is detected if its name ends with "mixin" (case insensitive).
-ignore-mixin-members=yes
-
-# List of classes names for which member attributes should not be checked
-# (useful for classes with attributes dynamically set).
-ignored-classes=SQLObject
-
-# When zope mode is activated, add a predefined set of Zope acquired attributes
-# to generated-members.
-zope=no
-
-# List of members which are set dynamically and missed by pylint inference
-# system, and so shouldn't trigger E0201 when accessed. Python regular
-# expressions are accepted.
-generated-members=REQUEST,acl_users,aq_parent
-
-
-[VARIABLES]
-
-# Tells whether we should check for unused import in __init__ files.
-init-import=no
-
-# A regular expression matching the beginning of the name of dummy variables
-# (i.e. not used).
-dummy-variables-rgx=_$|dummy
-
-# List of additional names supposed to be defined in builtins. Remember that
-# you should avoid to define new builtins when possible.
-additional-builtins=
-
-
-[CLASSES]
-
-# List of interface methods to ignore, separated by a comma. This is used for
-# instance to not check methods defines in Zope's Interface base class.
-ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
-
-# List of method names used to declare (i.e. assign) instance attributes.
-defining-attr-methods=__init__,__new__,setUp
-
-# List of valid names for the first argument in a class method.
-valid-classmethod-first-arg=cls
-
-# List of valid names for the first argument in a metaclass class method.
-valid-metaclass-classmethod-first-arg=mcs
-
-
-[DESIGN]
-
-# Maximum number of arguments for function / method
-max-args=5
-
-# Argument names that match this expression will be ignored. Default to name
-# with leading underscore
-ignored-argument-names=_.*
-
-# Maximum number of locals for function / method body
-max-locals=15
-
-# Maximum number of return / yield for function / method body
-max-returns=6
-
-# Maximum number of branch for function / method body
-max-branches=12
-
-# Maximum number of statements in function / method body
-max-statements=50
-
-# Maximum number of parents for a class (see R0901).
-max-parents=7
-
-# Maximum number of attributes for a class (see R0902).
-max-attributes=7
-
-# Minimum number of public methods for a class (see R0903).
-min-public-methods=2
-
-# Maximum number of public methods for a class (see R0904).
-max-public-methods=20
-
-
-[IMPORTS]
-
-# Deprecated modules which should not be used, separated by a comma
-deprecated-modules=regsub,TERMIOS,Bastion,rexec
-
-# Create a graph of every (i.e. internal and external) dependencies in the
-# given file (report RP0402 must not be disabled)
-import-graph=
-
-# Create a graph of external dependencies in the given file (report RP0402 must
-# not be disabled)
-ext-import-graph=
-
-# Create a graph of internal dependencies in the given file (report RP0402 must
-# not be disabled)
-int-import-graph=
-
-
-[EXCEPTIONS]
-
-# Exceptions that will emit a warning when being caught. Defaults to
-# "Exception"
-overgeneral-exceptions=Exception
+disable=locally-disabled,missing-docstring,invalid-name,too-few-public-methods,redefined-variable-type,import-error,similarities,unsupported-membership-test,unsubscriptable-object,ungrouped-imports

.travis.yml

@@ -9,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,197 @@
 Release History
 ===============
 
+PlatformIO 2.0
+--------------
+
+2.5.0 (2015-12-08)
+~~~~~~~~~~~~~~~~~~
+
+* Improved code builder for parallel builds (up to 4 times faster than before)
+* Generate `.travis.yml <http://docs.platformio.org/en/latest/ci/travis.html>`__
+  CI and `.gitignore` files for embedded projects by default
+  (`issue #354 <https://github.com/platformio/platformio/issues/354>`_)
+* Removed prompt with "auto-uploading" from `platformio init <http://docs.platformio.org/en/latest/userguide/cmd_init.html>`__
+  command and added ``--enable-auto-uploading`` option
+  (`issue #352 <https://github.com/platformio/platformio/issues/352>`_)
+* Fixed incorrect behaviour of `platformio serialports monitor <http://docs.platformio.org/en/latest/userguide/cmd_serialports.html#platformio-serialports-monitor>`__
+  in pair with PySerial 3.0
+
+2.4.1 (2015-12-01)
+~~~~~~~~~~~~~~~~~~
+
+* Restored ``PLATFORMIO`` macros with the current version
+
+2.4.0 (2015-12-01)
+~~~~~~~~~~~~~~~~~~
+
+* Added support for the new boards: Atmel ATSAMR21-XPRO, Atmel SAML21-XPRO-B,
+  Atmel SAMD21-XPRO, ST 32F469IDISCOVERY, ST 32L476GDISCOVERY, ST Nucleo F031K6,
+  ST Nucleo F042K6, ST Nucleo F303K8 and ST Nucleo L476RG
+* Updated Arduino core for Espressif platform to 2.0.0
+  (`issue #345 <https://github.com/platformio/platformio/issues/345>`_)
+* Added to FAQ explanation of `Can not compile a library that compiles without issue
+  with Arduino IDE <http://docs.platformio.org/en/latest/faq.html#building>`_
+  (`issue #331 <https://github.com/platformio/platformio/issues/331>`_)
+* Fixed ESP-12E flash size
+  (`pull #333 <https://github.com/platformio/platformio/pull/333>`_)
+* Fixed configuration for LowPowerLab MoteinoMEGA board
+  (`issue #335 <https://github.com/platformio/platformio/issues/335>`_)
+* Fixed "LockFailed: failed to create appstate.json.lock" error for Windows
+* Fixed relative include path for preprocessor using ``build_flags``
+  (`issue #271 <https://github.com/platformio/platformio/issues/271>`_)
+
+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>`__
@@ -33,21 +222,21 @@ Release History
   (`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
+* Avoided ``LibInstallDependencyError`` when more than 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
@@ -66,12 +255,12 @@ Release History
   (`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>`_
@@ -92,7 +281,7 @@ Release History
   (`issue #217 <https://github.com/platformio/platformio/issues/217>`_)
 
 2.0.0 (2015-05-22)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 *Made in* `Paradise <https://twitter.com/ikravets/status/592356377185619969>`_
 
@@ -139,8 +328,11 @@ Release History
 * 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
@@ -163,7 +355,7 @@ Release History
   (`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
@@ -189,7 +381,7 @@ Release History
 
 
 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>`_
@@ -210,7 +402,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*.
@@ -242,7 +434,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>`_)
@@ -260,7 +452,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**
 
@@ -327,9 +519,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>`_)
@@ -338,7 +532,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>`__,
@@ -350,7 +544,7 @@ Release History
   command
 
 0.10.0 (2015-01-01)
--------------------
+~~~~~~~~~~~~~~~~~~~
 
 **Happy New Year!**
 
@@ -373,7 +567,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>`_
@@ -382,7 +576,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>`__
@@ -391,13 +585,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.
@@ -415,7 +609,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>`_,
@@ -432,7 +626,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>`_)
@@ -440,7 +634,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>`_
@@ -448,14 +642,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"
@@ -470,7 +664,7 @@ 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
@@ -490,13 +684,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
@@ -506,7 +700,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"
@@ -515,6 +709,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

@@ -7,48 +7,63 @@ PlatformIO
 .. 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://api.shippable.com/projects/555b0ceeedd7f2c052f3c2d0/badge?branchName=develop
-    :target: https://app.shippable.com/projects/555b0ceeedd7f2c052f3c2d0
-    :alt: Shippable 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://gemnasium.com/platformio/platformio.png
-    :target: https://gemnasium.com/platformio/platformio
-    :alt: Dependency 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://img.shields.io/pypi/dm/platformio.svg
-    :target: https://pypi.python.org/pypi/platformio/
-    :alt: Downloads
 .. 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
-.. image:: https://www.openhub.net/p/platformio/widgets/project_thin_badge.gif
-   :target: https://www.openhub.net/p/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>`_
+`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 (Ready for embedded development, IDE and
-Continuous integration, Arduino and MBED compatible).
+`PlatformIO <http://platformio.org>`_ is an open source ecosystem for IoT
+development. Cross-platform code builder and library manager. Continuous and
+IDE integration. Arduino and MBED compatible. Ready for Cloud compiling.
+
+* **Development Platforms** - Embedded and Desktop development platforms with
+  pre-built toolchains, debuggers, uploaders and frameworks which work under
+  popular host OS: Mac, Windows, Linux (+ARM)
+* **Embedded Boards** - Rapid Embedded Programming, IDE and Continuous
+  Integration in a few steps with PlatformIO thanks to built-in project
+  generator for the most popular embedded boards and IDE
+* **Library Manager** - Hundreds Popular Libraries are organized into single
+  Web 2.0 platform: list by categories, keywords, authors, compatible
+  platforms and frameworks; learn via examples; be up-to-date with the latest
+  version
 
 *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>`_
 * `Development Platforms <http://platformio.org/#!/platforms>`_
@@ -62,15 +77,10 @@ libOpenCM3, etc.*
 * `FAQ <http://docs.platformio.org/en/latest/faq.html>`_
 * `Release History <http://docs.platformio.org/en/latest/history.html>`_
 
-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
-the most popular embedded boards. For further details, please
-refer to `What is PlatformIO? <http://docs.platformio.org/en/latest/faq.html#what-is-platformio>`_
-
 Use whenever. *Run everywhere.*
 -------------------------------
 *PlatformIO* is written in pure *Python* and **doesn't depend** on any
-additional libraries/tools from an operation system. It allows you to use
+additional libraries/tools from an operating system. It allows you to use
 *PlatformIO* beginning from *PC (Mac, Linux, Win)* and ending with credit-card
 sized computers (`Raspberry Pi <http://www.raspberrypi.org>`_,
 `BeagleBone <http://beagleboard.org>`_,
@@ -84,7 +94,7 @@ 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>`_
 * `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>`_
+* Cloud compiling and `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>`_
@@ -130,8 +140,8 @@ cross-platform substitute for the classic *Make* utility.
 
 Single source code. *Multiple platforms.*
 -----------------------------------------
-*PlatformIO* allows developer to compile the same code with different
-development platforms using the *Only One Command*
+*PlatformIO* allows the developer to compile the same code with different
+development platforms using only *One Command*
 `platformio run <http://docs.platformio.org/en/latest/userguide/cmd_run.html>`_.
 This happens due to
 `Project Configuration File (platformio.ini) <http://docs.platformio.org/en/latest/projectconf.html>`_
@@ -162,10 +172,12 @@ Frameworks:
 * `SPL <http://platformio.org/#!/frameworks/spl>`_
 * `mbed <http://platformio.org/#!/frameworks/mbed>`_
 
+For further details, please refer to `What is PlatformIO? <http://docs.platformio.org/en/latest/faq.html#what-is-platformio>`_
 
 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

@@ -1,15 +1,11 @@
 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:
@@ -17,4 +13,4 @@ dependencies:
 
 test:
     override:
-        - tox -e $TOX_ENV
+        - tox -e py27

docs/_static/extra.css

@@ -0,0 +1,254 @@
+/**
+ * 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.
+ */
+
+header,
+nav {
+  display: block;
+}
+
+#pionav {
+  display: none;
+}
+
+.container {
+  padding-right: 15px;
+  padding-left: 15px;
+  margin-right: auto;
+  margin-left: auto;
+}
+@media (min-width: 768px) {
+  #pionav {
+    display: block !important;
+  }
+  body {
+    padding-top: 50px;
+  }
+  .wy-nav-side {
+    top: 50px;
+  }
+  .container {
+    width: 750px;
+  }
+}
+@media (min-width: 992px) {
+  .container {
+    width: 970px;
+  }
+}
+@media (min-width: 1200px) {
+  .container {
+    width: 1170px;
+  }
+}
+.container-fluid {
+  padding-right: 15px;
+  padding-left: 15px;
+  margin-right: auto;
+  margin-left: auto;
+}
+
+.container:before,
+.container:after,
+.container-fluid:before,
+.container-fluid:after,
+.nav:before,
+.nav:after,
+.navbar:before,
+.navbar:after,
+.navbar-header:before,
+.navbar-header:after {
+  display: table;
+  content: " ";
+}
+.container:after,
+.container-fluid:after,
+.nav:after,
+.navbar:after,
+.navbar-header:after {
+  clear: both;
+}
+
+.nav {
+  padding-left: 0;
+  margin-bottom: 0;
+  list-style: none;
+}
+.nav > li {
+  position: relative;
+  display: block;
+}
+.nav > li > a {
+  position: relative;
+  display: block;
+  padding: 10px 15px;
+}
+.nav > li > a:hover,
+.nav > li > a:focus {
+  text-decoration: none;
+  background-color: #eee;
+}
+.nav > li > a > img {
+  max-width: none;
+}
+
+.navbar {
+  position: relative;
+  min-height: 50px;
+  margin-bottom: 20px;
+  border: 1px solid transparent;
+}
+@media (min-width: 768px) {
+  .navbar {
+    border-radius: 4px;
+  }
+}
+@media (min-width: 768px) {
+  .navbar-header {
+    float: left;
+  }
+}
+
+@media (min-width: 768px) {
+  .navbar-fixed-top {
+    padding-right: 0;
+    padding-left: 0;
+  }
+}
+.navbar-fixed-top {
+  max-height: 340px;
+}
+.container > .navbar-header,
+.container-fluid > .navbar-header {
+  margin-right: -15px;
+  margin-left: -15px;
+}
+@media (min-width: 768px) {
+  .container > .navbar-header,
+  .container-fluid > .navbar-header {
+    margin-right: 0;
+    margin-left: 0;
+  }
+}
+
+.navbar-fixed-top {
+  position: fixed;
+  right: 0;
+  left: 0;
+  z-index: 1030;
+}
+@media (min-width: 768px) {
+  .navbar-fixed-top {
+    border-radius: 0;
+  }
+}
+.navbar-fixed-top {
+  top: 0;
+  border-width: 0 0 1px;
+}
+.navbar-fixed-bottom {
+  bottom: 0;
+  margin-bottom: 0;
+  border-width: 1px 0 0;
+}
+.navbar-brand {
+  float: left;
+  height: 50px;
+  padding: 15px 15px;
+  font-size: 18px;
+  line-height: 20px;
+}
+.navbar-brand:hover,
+.navbar-brand:focus {
+  text-decoration: none;
+}
+.navbar-brand > img {
+  display: block;
+}
+@media (min-width: 768px) {
+  .navbar > .container .navbar-brand,
+  .navbar > .container-fluid .navbar-brand {
+    margin-left: -15px;
+  }
+}
+
+.navbar-nav {
+  margin: 7.5px -15px;
+}
+.navbar-nav > li > a {
+  padding-top: 10px;
+  padding-bottom: 10px;
+  line-height: 20px;
+}
+@media (min-width: 768px) {
+  .navbar-nav {
+    float: left;
+    margin: 0;
+  }
+  .navbar-nav > li {
+    float: left;
+  }
+  .navbar-nav > li > a {
+    padding-top: 15px;
+    padding-bottom: 15px;
+  }
+}
+
+@media (min-width: 768px) {
+  .navbar-left {
+    float: left !important;
+  }
+  .navbar-right {
+    float: right !important;
+    margin-right: -15px;
+  }
+  .navbar-right ~ .navbar-right {
+    margin-right: 0;
+  }
+}
+
+.navbar-inverse {
+  background-color: #222;
+  border-color: #080808;
+}
+.navbar-inverse .navbar-brand {
+  color: #9d9d9d;
+}
+.navbar-inverse .navbar-brand:hover,
+.navbar-inverse .navbar-brand:focus {
+  color: #fff;
+  background-color: transparent;
+}
+.navbar-inverse .navbar-text {
+  color: #9d9d9d;
+}
+.navbar-inverse .navbar-nav > li > a {
+  color: #9d9d9d;
+}
+.navbar-inverse .navbar-nav > li > a:hover,
+.navbar-inverse .navbar-nav > li > a:focus {
+  color: #fff;
+  background-color: transparent;
+}
+.navbar-inverse .navbar-nav > .active > a,
+.navbar-inverse .navbar-nav > .active > a:hover,
+.navbar-inverse .navbar-nav > .active > a:focus {
+  color: #fff;
+  background-color: #080808;
+}
+
+.navbar-header .navbar-brand {
+  color: #e0e0e0;
+}

docs/_templates/footer.html

@@ -0,0 +1,31 @@
+{% extends "!footer.html" %}
+
+{% block extrafooter %}
+<link rel="stylesheet" href="{{ pathto('_static/extra.css', 1) }}" type="text/css" />
+<header id="pionav" class="navbar navbar-inverse navbar-fixed-top">
+  <div class="container container-fluid">
+    <div class="navbar-header">
+      <a class="navbar-brand" href="http://platformio.org/"></i> PlatformIO</a>
+    </div>
+
+    <nav role="navigation">
+      <div>
+        <ul class="nav navbar-nav">
+          <li><a href="http://platformio.org/#!/get-started"><i class="fa fa-rocket fa-lg"></i> Get Started</a></li>
+          <li><a href="http://platformio.org/#!/platforms"><i class="fa fa-laptop fa-lg"></i> Platforms</a></li>
+          <li><a href="http://platformio.org/#!/frameworks"><i class="fa fa-cogs fa-lg"></i> Frameworks</a></li>
+          <li><a href="http://platformio.org/#!/boards"><i class="fa fa-gamepad fa-lg"></i> Boards</a></li>
+          <li ><a href="http://platformio.org/#!/lib"><i class="fa fa-code fa-lg"></i> Libraries</a></li>
+        </ul>
+
+        <ul class="nav navbar-nav navbar-right">
+          <li><a href="http://platformio.org/#!/who-uses"><i class="fa fa-heart-o fa-lg"></i> Who uses</a></li>
+          <li class="active"><a href="http://docs.platformio.org/"><i class="fa fa-book fa-lg"></i> Docs</a></li>
+        </ul>
+      </div>
+
+    </nav>
+  </div>
+</header>
+{{ super() }}
+{% endblock %}

docs/articles.rst

@@ -1,20 +1,57 @@
+..  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 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>`_.
+    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:
 
-* Jun 02, 2015 - **Alejandro Guirao Rodriguez** - `Discovering PlatformIO: The RaspberryPi / Arduino combo kit is a winner option when prototyping an IoT-style project <http://lekum.org/posts/discovering-platformio.html>`_
+2015
+^^^^
+
+* Dec 01, 2015 - **Tateno Yuichi** - `ESP8266 を CUI で開発する (Develop a ESP8266 in CUI, Japanese) <http://jaywiggins.com/platformio/arduino/avr/es8266/2015/09/30/platformio-investigation/>`_
+* Nov 29, 2015 - **Keith Hughes** - `Using PlatformIO for Embedded Projects <http://smartspacestuff.blogspot.com/2015/11/using-platformio-for-embedded-projects.html>`_
+* Nov 22, 2015 - **Michał Seroczyński** - `Using PlatformIO to get started with Arduino in CLion IDE <http://www.ches.pl/using-platformio-get-started-arduino-clion-ide/>`_
+* 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 21, 2015 - **Vittorio Zaccaria** - `Using a cheap STM32 Nucleo to teach remote sensor monitoring <http://www.vittoriozaccaria.net/blog/2015/10/21/using-a-cheap-stm32-nucleo-to-teach-remote-sensor-monitoring.html>`_
+* Oct 18, 2015 - **Nico Coetzee** - `First Arduino I2C Experience with PlatformIO <https://electronicventurer.wordpress.com/2015/10/18/first-arduino-i2c-experience/>`_
+* Oct 01, 2015 - **Mistan** - `Compile and Upload Arduino Sketch with PlatformIO for Raspberry Pi Running Arch Linux <http://tech.memoryimprintstudio.com/code-building-for-arduino-with-platformio-for-raspberry-pi-with-arch-linux/>`_
+* Sep 30, 2015 - **Jay Wiggins** - `PlatformIO Investigation <http://jaywiggins.com/platformio/arduino/avr/es8266/2015/09/30/platformio-investigation/>`_
+* 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 08, 2015 - **Josh Glendenning** - `Armstrap Eagle and PlatformIO <http://isobit.io/2015/08/08/armstrap.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

@@ -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.
+
 .. _ci_appveyor:
 
 AppVeyor
@@ -22,6 +33,8 @@ 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
 -----------
 
@@ -113,17 +126,12 @@ same for the all projects, don't need to modify them):
 
 
     function InstallPip ($python_home) {
-        $pip_path = $python_home + "/Scripts/pip.exe"
         $python_path = $python_home + "/python.exe"
-        if (-not(Test-Path $pip_path)) {
-            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
-        } else {
-            Write-Host "pip already installed."
-        }
+        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) {
@@ -131,19 +139,11 @@ same for the all projects, don't need to modify them):
         & $pip_path install -U $pkg
     }
 
-    function InstallScons ($python_home) {
-        Write-Host "Start installing Scons"
-        $pip_path = $python_home + "/Scripts/pip.exe"
-        & $pip_path install --egg "http://sourceforge.net/projects/scons/files/latest/download"
-        Write-Host "Scons installed"
-    }
-
     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
-        InstallScons $env:PYTHON_HOME
     }
 
     main

docs/ci/circleci.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.
+
 .. _ci_circleci:
 
 Circle CI
@@ -21,52 +32,174 @@ 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.
+Please make sure to read Circle CI `Getting Started <https://circleci.com/docs/getting-started>`_
+guide first.
+
+.. code-block:: yaml
+
+    dependencies:
+        pre:
+            # Install the latest stable PlatformIO
+            - sudo pip install -U platformio
+
+    test:
+        override:
+            - platformio ci path/to/test/file.c --board=TYPE_1 --board=TYPE_2 --board=TYPE_N
+            - platformio ci examples/file.ino --board=TYPE_1 --board=TYPE_2 --board=TYPE_N
+            - platformio ci path/to/test/directory --board=TYPE_1 --board=TYPE_2 --board=TYPE_N
+
+
+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
+
+    dependencies:
+        pre:
+            # Install the latest stable PlatformIO
+            - sudo pip install -U platformio
+
+            # OneWire Library with ID=1 http://platformio.org/#!/lib/show/1/OneWire
+            - platformio lib install 1
+
+    test:
+        override:
+            - platformio ci path/to/test/file.c --board=TYPE_1 --board=TYPE_2 --board=TYPE_N
+
+Manually download dependent library and include in build process via ``--lib`` option
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: yaml
+
+    dependencies:
+        pre:
+            # Install the latest stable PlatformIO
+            - sudo 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/
+
+    test:
+        override:
+            - platformio ci path/to/test/file.c --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
 
     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
+            PLATFORMIO_BUILD_FLAGS: -D SPECIFIC_MACROS -I/extra/inc
 
-    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)"
+
+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
 
     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.
+            - platformio ci path/to/test/file.c --project-conf=/path/to/platoformio.ini
 
 Examples
 --------
 
-1. Integration for `USB_Host_Shield_2.0 <https://github.com/felis/USB_Host_Shield_2.0>`_
-   project. The ``circle.yml`` configuration file:
+1. Custom build flags
 
 .. code-block:: yaml
 
-    machine:
-        environment:
-            PLATFORMIO_CI_SRC: examples/Bluetooth/PS3SPP/PS3SPP.ino
-            PLATFORMIO_CI_SRC: examples/pl2303/pl2303_gps/pl2303_gps.ino
-
     dependencies:
+        cache_directories:
+            - "~/.platformio"
+
         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
+            - sudo pip install -U platformio
+
+            # pre-install PlatformIO development platforms, they will be cached
+            - platformio platforms install atmelavr atmelsam teensy
+
+            #
+            # Libraries from PlatformIO Library Registry:
+            #
+            # http://platformio.org/#!/lib/show/416/TinyGPS
+            # http://platformio.org/#!/lib/show/417/SPI4Teensy3
+            - platformio lib install 416 417
 
     test:
         override:
-            - platformio ci --lib="." --lib="/tmp/spi4teensy3-master" --board=uno --board=teensy31 --board=due
+            - platformio ci examples/acm/acm_terminal --board=uno --board=teensy31 --board=due --lib="."
+            - platformio ci examples/adk/adk_barcode --board=uno --board=teensy31 --board=due --lib="."
+            - platformio ci examples/adk/ArduinoBlinkLED --board=uno --board=teensy31 --board=due --lib="."
+            - platformio ci examples/adk/demokit_20 --board=uno --board=teensy31 --board=due --lib="."
+            # ...
+            - platformio ci examples/Xbox/XBOXUSB --board=uno --board=teensy31 --board=due --lib="."
+
+* Configuration file: https://github.com/ivankravets/USB_Host_Shield_2.0/blob/master/circle.yml
+* Build History: https://circleci.com/gh/ivankravets/USB_Host_Shield_2.0/tree/master
+
+2. Dependency on external libraries
+
+.. code-block:: yaml
+
+    dependencies:
+        pre:
+            # Install the latest stable PlatformIO
+            - sudo pip install -U platformio
+
+            # download dependent libraries
+            - 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
+
+    test:
+        override:
+            -  platformio ci examples/backSoon/backSoon.ino --lib="." --lib="/tmp/jeelib-master" --lib="/tmp/Gamebuino-master/libraries/tinyFAT" --board=uno --board=megaatmega2560
+            -  platformio ci examples/etherNode/etherNode.ino --lib="." --lib="/tmp/jeelib-master" --lib="/tmp/Gamebuino-master/libraries/tinyFAT" --board=uno --board=megaatmega2560
+            -  platformio ci examples/getDHCPandDNS/getDHCPandDNS.ino --lib="." --lib="/tmp/jeelib-master" --lib="/tmp/Gamebuino-master/libraries/tinyFAT" --board=uno --board=megaatmega2560
+            -  platformio ci examples/getStaticIP/getStaticIP.ino --lib="." --lib="/tmp/jeelib-master" --lib="/tmp/Gamebuino-master/libraries/tinyFAT" --board=uno --board=megaatmega2560
+            # ...
+            -  platformio ci examples/twitter/twitter.ino --lib="." --lib="/tmp/jeelib-master" --lib="/tmp/Gamebuino-master/libraries/tinyFAT" --board=uno --board=megaatmega2560
+            -  platformio ci examples/udpClientSendOnly/udpClientSendOnly.ino --lib="." --lib="/tmp/jeelib-master" --lib="/tmp/Gamebuino-master/libraries/tinyFAT" --board=uno --board=megaatmega2560
+            -  platformio ci examples/udpListener/udpListener.ino --lib="." --lib="/tmp/jeelib-master" --lib="/tmp/Gamebuino-master/libraries/tinyFAT" --board=uno --board=megaatmega2560
+            -  platformio ci examples/webClient/webClient.ino --lib="." --lib="/tmp/jeelib-master" --lib="/tmp/Gamebuino-master/libraries/tinyFAT" --board=uno --board=megaatmega2560
+
+* Configuration file: hhttps://github.com/ivankravets/ethercard/blob/master/circle.yaml
+* Build History: https://circleci.com/gh/ivankravets/ethercard/tree/master

docs/ci/drone.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.
+
 .. _ci_drone:
 
 Drone
@@ -20,6 +31,8 @@ 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
 -----------
 

docs/ci/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.
+
 .. _ci:
 
 Continuous Integration

docs/ci/shippable.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.
+
 .. _ci_shippable:
 
 Shippable
@@ -24,6 +35,8 @@ 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
 -----------
 

docs/ci/travis.rst

@@ -1,8 +1,26 @@
+..  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
 =========
 
+.. image:: ../_static/ci-travis-logo.png
+    :target: https://docs.travis-ci.com/user/integration/platformio/
+
+
+**Travis CI** `officially supports <https://docs.travis-ci.com/user/integration/platformio/>`_
+**PlatformIO for Embedded Builds.**
+
 `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>`_.
@@ -21,10 +39,17 @@ 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 ``.travis.yml`` to the root directory of the GitHub repository.
+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
 
@@ -32,28 +57,111 @@ Please put ``.travis.yml`` to the root directory of the GitHub repository.
     python:
         - "2.7"
 
+    # Cache PlatformIO packages using Travis CI container-based infrastructure
+    sudo: false
+    cache:
+        directories:
+            - "~/.platformio"
+
     env:
-        - PLATFORMIO_CI_SRC=path/to/source/file.c
-        - PLATFORMIO_CI_SRC=path/to/source/file.ino
-        - PLATFORMIO_CI_SRC=path/to/source/directory
+        - PLATFORMIO_CI_SRC=path/to/test/file.c
+        - PLATFORMIO_CI_SRC=examples/file.ino
+        - PLATFORMIO_CI_SRC=path/to/test/directory
 
     install:
-        - python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
+        - 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/
 
-Then see step 1, 2, and step 4 here: http://docs.travis-ci.com/user/getting-started/
+For more details as for PlatformIO build process please look into :ref:`cmd_ci`.
 
-For more details as for PlatformIO build process please look into :ref:`cmd_ci`
-command.
+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. Integration for `USB_Host_Shield_2.0 <https://github.com/felis/USB_Host_Shield_2.0>`_
-   project. The ``.travis.yml`` configuration file:
+1. Custom build flags
 
 .. code-block:: yaml
 
@@ -61,6 +169,12 @@ Examples
     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"
@@ -69,9 +183,11 @@ Examples
         # - ...
 
     install:
-        - python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
+        - pip install -U platformio
 
-        # Libraries from PlatformIO Library Registry
+        #
+        # Libraries from PlatformIO Library Registry:
+        #
         # http://platformio.org/#!/lib/show/416/TinyGPS
         # http://platformio.org/#!/lib/show/417/SPI4Teensy3
         - platformio lib install 416 417
@@ -81,3 +197,74 @@ Examples
 
 * 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/conf.py

@@ -119,12 +119,12 @@ html_theme = 'default'
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+#html_logo = '_static/platformio-logo.png'
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+html_favicon = '_static/favicon.ico'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -184,22 +184,22 @@ htmlhelp_basename = 'PlatformIOdoc'
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
+    # The paper size ('letterpaper' or 'a4paper').
+    #'papersize': 'letterpaper',
 
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
+    # The font size ('10pt', '11pt' or '12pt').
+    #'pointsize': '10pt',
 
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
+    # Additional stuff for the LaTeX preamble.
+    #'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', 'PlatformIO.tex', u'PlatformIO Documentation',
-   u'Ivan Kravets', 'manual'),
+    ('index', 'PlatformIO.tex', u'PlatformIO Documentation',
+     u'Ivan Kravets', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -242,9 +242,9 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'PlatformIO', u'PlatformIO Documentation',
-   u'Ivan Kravets', 'PlatformIO', 'One line description of project.',
-   'Miscellaneous'),
+    ('index', 'PlatformIO', u'PlatformIO Documentation',
+     u'Ivan Kravets', 'PlatformIO', 'One line description of project.',
+     'Miscellaneous'),
 ]
 
 # Documents to append as an appendix to all manuals.

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,33 +37,21 @@ 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:
-
-PLATFORMIO_HOME_DIR
-~~~~~~~~~~~~~~~~~~~
+.. envvar:: PLATFORMIO_HOME_DIR
 
 Allows to override :ref:`projectconf` option :ref:`projectconf_pio_home_dir`.
 
-.. _envvar_PLATFORMIO_LIB_DIR:
-
-PLATFORMIO_LIB_DIR
-~~~~~~~~~~~~~~~~~~
+.. envvar:: PLATFORMIO_LIB_DIR
 
 Allows to override :ref:`projectconf` option :ref:`projectconf_pio_lib_dir`.
 
-.. _envvar_PLATFORMIO_SRC_DIR:
-
-PLATFORMIO_SRC_DIR
-~~~~~~~~~~~~~~~~~~
+.. envvar:: PLATFORMIO_SRC_DIR
 
 Allows to override :ref:`projectconf` option :ref:`projectconf_pio_src_dir`.
 
-.. _envvar_PLATFORMIO_ENVS_DIR:
-
-PLATFORMIO_ENVS_DIR
-~~~~~~~~~~~~~~~~~~~
+.. envvar:: PLATFORMIO_ENVS_DIR
 
 Allows to override :ref:`projectconf` option :ref:`projectconf_pio_envs_dir`.
 
@@ -63,74 +59,53 @@ Allows to override :ref:`projectconf` option :ref:`projectconf_pio_envs_dir`.
 Builder
 -------
 
-.. _envvar_PLATFORMIO_BUILD_FLAGS:
-
-PLATFORMIO_BUILD_FLAGS
-~~~~~~~~~~~~~~~~~~~~~~
+.. envvar:: PLATFORMIO_BUILD_FLAGS
 
 Allows to set :ref:`projectconf` option :ref:`projectconf_build_flags`.
 
-.. _envvar_PLATFORMIO_SRC_BUILD_FLAGS:
-
-PLATFORMIO_SRC_BUILD_FLAGS
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. envvar:: PLATFORMIO_SRC_BUILD_FLAGS
 
 Allows to set :ref:`projectconf` option :ref:`projectconf_src_build_flags`.
 
-.. _envvar_PLATFORMIO_SRC_FILTER:
-
-PLATFORMIO_SRC_FILTER
-~~~~~~~~~~~~~~~~~~~~~
+.. envvar:: PLATFORMIO_SRC_FILTER
 
 Allows to set :ref:`projectconf` option :ref:`projectconf_src_filter`.
 
-.. _envvar_PLATFORMIO_EXTRA_SCRIPT:
-
-PLATFORMIO_EXTRA_SCRIPT
-~~~~~~~~~~~~~~~~~~~~~~~
+.. envvar:: PLATFORMIO_EXTRA_SCRIPT
 
 Allows to set :ref:`projectconf` option :ref:`projectconf_extra_script`.
 
+
 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 ecosystem for IoT
+development.
 
 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,54 +67,159 @@ 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>`_.
+
+Windows AttributeError: 'module' object has no attribute 'packages'
+'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+
+Answered in `issue #252 <https://github.com/platformio/platformio/issues/252#issuecomment-127072039>`_.
+
+.. _faq_troubleshooting_pionotfoundinpath:
+
+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>`_.
+
+PlatformIO: command not found || An error "pkg_resources.DistributionNotFound"
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+
+Please upgrade *SetupTools* package:
+
+.. code-block:: bash
+
+    [sudo] pip uninstall setuptools
+    [sudo] pip install setuptools
+
+    # Then re-install PlatformIO
+    [sudo] pip uninstall platformio
+    [sudo] pip install platformio
+
+Miscellaneous
+~~~~~~~~~~~~~
+
 .. _faq_troubleshooting_pioblocksprompt:
 
 PlatformIO blocks command execution using user prompt
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+'''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 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 :option:`platformio --force` option before each command
-- using environment variable :ref:`PLATFORMIO_SETTING_ENABLE_PROMPTS=No <envvar_PLATFORMIO_SETTING_ENABLE_PROMPTS>`
+- 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>`.
-
-
-Windows: ``UnicodeDecodeError: 'ascii' codec can't decode byte``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Answered in `issue #143 <https://github.com/platformio/platformio/issues/143#issuecomment-88060906>`_.
+  :envvar:`CI=true <CI>`.
 
 Serial does not work with panStampAVR board
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+'''''''''''''''''''''''''''''''''''''''''''
 
 Answered in `issue #144 <https://github.com/platformio/platformio/issues/144#issuecomment-87388038>`_.
 
+Building
+~~~~~~~~
 
-PlatformIO: command not found || An error ``pkg_resources.DistributionNotFound``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Can not compile a library that compiles without issue with Arduino IDE
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
-Please upgrade *SetupTools* package:
+* `#298: Unable to use Souliss library <https://github.com/platformio/platformio/issues/298>`_
+* `#331: Unable to use MySensors library <https://github.com/platformio/platformio/issues/331>`_
 
-.. code-block:: bash
-
-    $ [sudo] pip uninstall setuptools
-    $ [sudo] pip install setuptools
-
-    # Then re-install PlatformIO
-    $ [sudo] pip uninstall platformio
-    $ [sudo] pip install platformio
-
-ARM toolchain: ``cc1plus: error while loading shared libraries``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+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
 ~~~~~~~~
 
@@ -949,3 +983,23 @@ Wicked Device
       - 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/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

@@ -31,6 +31,9 @@ Platforms
     * - :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
 ------
 
@@ -469,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

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,6 +18,8 @@ IDE Integration
     :maxdepth: 2
 
     ide/arduino
+    ide/atom
+    ide/clion
     ide/eclipse
     ide/energia
     ide/qtcreator

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
@@ -17,12 +28,20 @@ This software can be used with:
 Refer to the `Arduino Getting Started <http://arduino.cc/en/Guide/HomePage>`_
 page for Installation instructions.
 
+.. contents::
+
 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>`_.
 
+Articles / Manuals
+------------------
+
+* `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>`_
+
+See the full list with :ref:`articles`.
 
 Screenshot
 ----------

docs/ide/atom.rst

@@ -0,0 +1,57 @@
+..  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.
+
+Articles / Manuals
+------------------
+
+* `Arduino Development in Atom Editor <http://viget.com/extend/arduino-development-in-atom-editor>`_
+
+See a full list with :ref:`articles`.
+
+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,101 @@
+..  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::
+    The libraries which are added, installed or used in the project
+    after generating process wont be reflected in IDE. To fix it you
+    need to reinitialize project using :ref:`cmd_init` (repeat it).
+
+.. 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>`_.
+
+Articles / Manuals
+------------------
+
+* `Using PlatformIO to get started with Arduino in CLion IDE <http://www.ches.pl/using-platformio-get-started-arduino-clion-ide/>`_
+* `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/>`_
+
+See a full list with :ref:`articles`.
+
+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
@@ -26,9 +37,6 @@ page for more detailed information.
 Integration
 -----------
 
-Project Generator
-^^^^^^^^^^^^^^^^^
-
 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:
@@ -37,19 +45,38 @@ Since PlatformIO 2.0 you can generate Eclipse compatible project using
 
     platformio init --ide eclipse --board %TYPE%
 
-Then import this project via ``File > Import... > General > Existing Projects
-into Workspace > Next`` and specify root directory where is located
-:ref:`projectconf`.
+Then:
 
-Manual Integration
-^^^^^^^^^^^^^^^^^^
+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``.
 
-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>`_.
+.. warning::
+    The libraries which are added, installed or used in the project
+    after generating process wont be reflected in IDE. To fix it you
+    need to reinitialize project using :ref:`cmd_init` (repeat it).
 
-`More examples (TI MSP430, TI TIVA, etc.) <https://github.com/platformio/platformio/tree/develop/examples/ide-eclipse>`_
+Articles / Manuals
+------------------
+
+* `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>`_
+* `Learning Arduino GitHub Repository <http://www.trojanc.co.za/2015/07/11/learning-arduino-github-repository/>`_
+
+See a full list with :ref:`articles`.
 
 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
+
+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
@@ -17,12 +28,21 @@ This software can be used with:
 Refer to the `Energia Getting Started <http://energia.nu/guide/>`_
 page for Installation instructions.
 
+.. contents::
+
 Integration
 -----------
 
 More detailed information is located in PlatformIO blog:
 `Integration of PlatformIO library manager to Energia IDE <http://www.ikravets.com/computer-life/platformio/2014/10/07/integration-of-platformio-library-manager-to-arduino-and-energia-ides>`_.
 
+Articles / Manuals
+------------------
+
+* `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>`_
+
+See the full list with :ref:`articles`.
+
 Screenshot
 -----------
 

docs/ide/qtcreator.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_qtcreator:
 
 Qt Creator
@@ -18,6 +29,11 @@ page for more detailed information.
 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
 ^^^^^^^^^^^^^^^^^
 
@@ -29,14 +45,51 @@ Since PlatformIO 2.0 you can generate Qt Creator compatible project using
 
     platformio init --ide qtcreator --board %TYPE%
 
-Then import this project via ``File > New File or Project > Import Project``
-and specify root directory where is located :ref:`projectconf`.
+Then:
 
-After import, 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):
+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
 
+.. warning::
+    The libraries which are added, installed or used in the project
+    after generating process wont be reflected in IDE. To fix it you
+    need to reinitialize project using :ref:`cmd_init` (repeat it).
+
 Manual Integration
 ^^^^^^^^^^^^^^^^^^
 
@@ -129,12 +182,21 @@ Edit the content to match the code described below.
     framework = arduino
     board = uno
 
-
 Conclusion
-----------
+~~~~~~~~~~
 
-Taking everything into account, we can build project with shortcut ``Ctrl+Shift+B`` or using ``Menu: Build > Build All``:
+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
@@ -29,12 +40,23 @@ Since PlatformIO 2.0 you can generate Sublime Text compatible project using
 
     platformio init --ide sublimetext --board %TYPE%
 
-Then import this project via ``Project > Open Project...`` and specify root
-directory where is located :ref:`projectconf`.
+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
 ~~~~~~~~~~~~~~~~~~~~~
 
@@ -45,17 +67,17 @@ described below:
 .. code-block:: bash
 
     {
-        "cmd": ["platformio", "--force", "run"],
+        "cmd": ["platformio", "-f", "-c", "sublimetext", "run"],
         "working_dir": "${project_path:${folder}}",
         "variants":
         [
             {
                 "name": "Clean",
-                "cmd": ["platformio", "--force", "run", "--target", "clean"]
+                "cmd": ["platformio", "-f", "-c", "sublimetext", "run", "--target", "clean"]
             },
             {
                 "name": "Upload",
-                "cmd": ["platformio", "--force", "run", "--target", "upload"]
+                "cmd": ["platformio", "-f", "-c", "sublimetext", "run", "--target", "upload"]
             }
         ]
     }
@@ -139,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
+----------
+
 .. 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
@@ -12,9 +23,16 @@ This software can be used with:
 * all available :ref:`platforms`
 * all available :ref:`frameworks`
 
+.. 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`.
+
 Recommended bundles:
 
 * Syntax highlight - `Arduino-syntax-file <https://github.com/vim-scripts/Arduino-syntax-file>`_
@@ -30,16 +48,27 @@ Put to the project directory ``Makefile`` wrapper with contents:
     #PATH := /usr/local/bin:$(PATH)
 
     all:
-        platformio --force run --target upload
+        platformio -f -c vim run --target upload
 
     clean:
-        platformio --force run --target clean
+        platformio -f -c vim run --target clean
 
 
 Now, in VIM ``cd /path/to/this/project`` and press ``Ctrl+B`` or ``Cmd+B``
 (Mac). *PlatformIO* should compile your source code from the ``src`` directory,
 make firmware and upload it.
 
+.. note::
+    If hotkey doesn't work for you, try to add this line
+    ``nnoremap <C-b> :make<CR>`` to ``~/.vimrc``
+
+Articles / Manuals
+------------------
+
+* `コマンドラインでArduino開発 : vim + platformio (Arduino development at the command line: VIM + PlatformIO, Japanese) <http://qiita.com/caad1229/items/7b5fb47f034ae6e0baf2>`_
+
+See a full list with :ref:`articles`.
+
 Screenshot
 ----------
 

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
@@ -18,6 +29,11 @@ page for more detailed information.
 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
 ^^^^^^^^^^^^^^^^^
 
@@ -29,8 +45,17 @@ Since PlatformIO 2.0 you can generate Visual Studio compatible project using
 
     platformio init --ide visualstudio --board %TYPE%
 
-Then import this project via ``File->Open->Project/Solution`` and specify root
-directory where is located :ref:`projectconf`.
+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``.
+
+.. warning::
+    The libraries which are added, installed or used in the project
+    after generating process wont be reflected in IDE. To fix it you
+    need to reinitialize project using :ref:`cmd_init` (repeat it).
 
 Manual Integration
 ^^^^^^^^^^^^^^^^^^
@@ -118,9 +143,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``:
+Taking everything into account, we can build project with shortcut ``Ctrl+Shift+B`` or using ``Menu: Build > Build Solution``.
+
+Screenshot
+----------
 
 .. 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,15 +1,34 @@
-PlatformIO is 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.
 
-**Ready for embedded development, IDE and Continuous integration, Arduino and
-MBED compatible**
+PlatformIO is an open source ecosystem for IoT development
+==========================================================
+
+**Cross-platform code builder and library manager. Continuous and IDE
+integration. Arduino and MBED compatible. Ready for Cloud compiling.**
+
+* **Development Platforms** - Embedded and Desktop development platforms with
+  pre-built toolchains, debuggers, uploaders and frameworks which work under
+  popular host OS: Mac, Windows, Linux (+ARM)
+* **Embedded Boards** - Rapid Embedded Programming, IDE and Continuous
+  Integration in a few steps with PlatformIO thanks to built-in project
+  generator for the most popular embedded boards and IDE
+* **Library Manager** - Hundreds Popular Libraries are organized into single
+  Web 2.0 platform: list by categories, keywords, authors, compatible
+  platforms and frameworks; learn via examples; be up-to-date with the latest
+  version
 
 *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
+libOpenCM3, etc.**
 
 * `Website <http://platformio.org>`_
 * `Web 2.0 Library Search <http://platformio.org/#!/lib>`_ |
@@ -18,13 +37,10 @@ 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>`_
-
-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
-the most popular embedded boards. For further details, please
-refer to :ref:`faq_what_is_platformio`
+  `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/>`_
 
 Embedded Development. *Easier Than Ever.*
 -----------------------------------------
@@ -32,7 +48,7 @@ Embedded Development. *Easier Than Ever.*
 * Colourful command-line output
 * :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*
+* Cloud compiling and  :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
@@ -55,23 +71,54 @@ The Missing Library Manager. *It's here!*
 * Automatic library updating
 * It runs on Windows, Mac OS X, and Linux (+ARM).
 
+For further details, please refer to :ref:`faq_what_is_platformio`
 
 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
-    librarymanager/index
-    userguide/index
+
+.. toctree::
+    :caption: Library Manager
+    :maxdepth: 2
+
+    Quickstart <librarymanager/index>
+    User Guide <userguide/lib/index.rst>
+    librarymanager/config
+    librarymanager/creating
+
+.. toctree::
+    :caption: Integration
+    :maxdepth: 2
+
     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.
-
-.. 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`.
+* Mac OS X / Linux – *Terminal* application
+* Windows – ``cmd.exe`` application.
 
 Installation Methods
 --------------------
 
-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.
 
-Super-Quick (Mac / Linux)
+Please *choose ONE of* the following methods:
+
+a) 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:
+
+b) 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,62 +108,70 @@ 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
-~~~~~~~~~~
+c) Full Guide
+~~~~~~~~~~~~~
 
 1. Check a ``python`` version (only 2.6-2.7 is supported):
 
 .. 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
+    pip install -U platformio
 
-For upgrading the ``platformio`` to new version please use this command:
-
-.. code-block:: bash
-
-    $ pip install -U platformio
-
-
-Development Version
-~~~~~~~~~~~~~~~~~~~
-
-.. warning::
-    We don't recommend to use ``develop`` version in production.
+d) Development Version
+~~~~~~~~~~~~~~~~~~~~~~
 
 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 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:
 
@@ -325,6 +336,6 @@ A list of example patterns. This field is predefined with default value:
 .. code-block:: javascript
 
     "examples": [
-        "[Ee]xamples/*/*.ini",
+        "[Ee]xamples/*/*.ino",
         "[Ee]xamples/*/*.pde"
     ]

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*
 

docs/librarymanager/index.rst

@@ -1,12 +1,19 @@
+..  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
 ===============
 
-..
-
-    *"The missing library manager for development platforms"* [#]_
-
 *PlatformIO Library Manager* allows you to organize external embedded libraries.
 You can search for new libraries via
 
@@ -16,12 +23,4 @@ You can search for new libraries via
 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.
 
-.. toctree::
-    :maxdepth: 2
-
-    config
-    creating
-    User Guide <../userguide/lib/index.rst>
-
-.. [#] Inspired by `npm <https://www.npmjs.com/>`_ and `bower
-    <http://bower.io>`_ package managers for web.
+.. image:: ../_static/platformio-demo-lib.gif

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
 ~~~~~~~~
 
@@ -842,3 +883,23 @@ Wicked Device
       - 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

@@ -1,7 +1,18 @@
+..  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
-==============
+Custom Board
+============
 
 *PlatformIO* has pre-built settings for the most popular embedded boards. This
 list is available:

docs/platforms/creating_platform.rst

@@ -1,7 +1,18 @@
+..  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
-=================
+Custom Platform
+===============
 
 *PlatformIO* was developed like a tool which would build the same source code
 for the different development platforms via single command :ref:`cmd_run`
@@ -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
@@ -381,7 +406,7 @@ and copy there two files:
     # Target: Build executable and linkable firmware
     #
 
-    target_elf = env.BuildFirmware()
+    target_elf = env.BuildProgram()
 
     #
     # Target: Build the .bin file

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
 
@@ -25,5 +39,24 @@ MCU, upload protocol or etc. Please use ``board`` option.
     teensy
     timsp430
     titiva
+
+Desktop
+-------
+
+.. toctree::
+    :maxdepth: 2
+
+    native
+    linux_arm
+    linux_i686
+    linux_x86_64
+    windows_x86
+
+Custom 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

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

@@ -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_siliconlabsefm32:
 
 Platform ``siliconlabsefm32``
@@ -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/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
@@ -253,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
@@ -262,7 +278,7 @@ processes:
         ``-l``.
 
 This option can be set by global environment variable
-:ref:`envvar_PLATFORMIO_BUILD_FLAGS`.
+:envvar:`PLATFORMIO_BUILD_FLAGS`.
 
 Example:
 
@@ -304,7 +320,7 @@ but will be applied only for the project source code from
 :ref:`projectconf_pio_src_dir` directory.
 
 This option can be set by global environment variable
-:ref:`envvar_PLATFORMIO_SRC_BUILD_FLAGS`.
+:envvar:`PLATFORMIO_SRC_BUILD_FLAGS`.
 
 .. _projectconf_src_filter:
 
@@ -326,7 +342,7 @@ By default, ``src_filter`` is predefined to
 exclude ``.git`` and ``svn`` repository folders and exclude ``examples`` folder.
 
 This option can be set by global environment variable
-:ref:`envvar_PLATFORMIO_SRC_FILTER`.
+:envvar:`PLATFORMIO_SRC_FILTER`.
 
 ``lib_install``
 ^^^^^^^^^^^^^^^
@@ -399,7 +415,7 @@ 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
-:ref:`envvar_PLATFORMIO_EXTRA_SCRIPT`.
+:envvar:`PLATFORMIO_EXTRA_SCRIPT`.
 
 Example, specify own upload command for :ref:`platform_atmelavr`:
 
@@ -424,20 +440,18 @@ Example, specify own upload command for :ref:`platform_atmelavr`:
     # 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>`_.
+
+* see built-in examples of `PlatformIO build scripts <https://github.com/platformio/platformio/tree/develop/platformio/builder/scripts>`_.
+* take a look on related users questions: `#351 <https://github.com/platformio/platformio/issues/351#issuecomment-161789165>`_,
+  `#236 <https://github.com/platformio/platformio/issues/236#issuecomment-112038284>`_,
+  `#247 <https://github.com/platformio/platformio/issues/247#issuecomment-118169728>`_
 
 ``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".
-
-Pre-built targets:
-
-* ``clean`` delete compiled object files, libraries and firmware binaries
-* ``upload`` enable "auto-uploading" for embedded platforms after building
-  operation
-* ``envdump`` dump current build environment
+default. You can enter more than 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:
@@ -476,39 +490,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
@@ -528,7 +510,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
@@ -539,42 +521,27 @@ 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
 
+Also, take a look at this article `Armstrap Eagle and PlatformIO <http://isobit.io/2015/08/08/armstrap.html>`_.
 
-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
@@ -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

@@ -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_ci:
 
 platformio ci

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
@@ -16,15 +27,21 @@ Usage
 Description
 -----------
 
-Initialize new PlatformIO based project.
+Initialize new PlatformIO based project or update existing with new data.
 
 
 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
+* ``.travis.yml`` configuration file (template) for Continuous Integration
+  with :ref:`ci_travis`
+
+.. note::
+    The source code of each library should be placed in separate directory.
+    For example, ``lib/private_lib/[here are source files]``.
 
 Options
 -------
@@ -59,22 +76,21 @@ A list with supported IDE is available within ``platformio init --help`` command
 Also, please look into :ref:`ide` page.
 
 .. option::
-    --disable-auto-uploading
+    --enable-auto-uploading
 
 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.
+will create environment with enabled firmware auto-uploading.
 
 .. 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
 --------
 
@@ -90,8 +106,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:
@@ -108,8 +124,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:
@@ -123,17 +139,14 @@ Examples
 
     $ platformio init --board uno
 
-    Would you like to enable firmware auto-uploading when project is successfully built using `platformio run` command?
-    Don't forget that you can upload firmware manually using `platformio run --target upload` command. [y/N]: y
-
     The current working directory *** will be used for the new project.
     You can specify another project directory via
     `platformio init -d %PATH_TO_THE_PROJECT_DIR%` command.
 
     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
@@ -33,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
@@ -42,10 +63,10 @@ Upload port of embedded board. To print all available ports use
 :ref:`cmd_serialports` command
 
 .. option::
-    --build-dir
+    -d, --project-dir
 
-Specify the path to project directory. By default, ``--build-dir`` is equal to
-current working directory (``CWD``).
+Specify the path to project directory. By default, ``--project-dir`` is equal
+to current working directory (``CWD``).
 
 .. option::
     -v, --verbose
@@ -62,6 +83,12 @@ There 3 levels of verbosity:
 
 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
@@ -140,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
@@ -182,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
 ~~~~~~~~
 
@@ -201,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_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

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,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:
 
 User Guide
@@ -18,7 +29,7 @@ Options
 .. program:: platformio
 
 .. option::
-    --force, - f
+    --force, -f
 
 Force to accept any confirmation prompts. This option allows to avoid an issue
 with :ref:`faq_troubleshooting_pioblocksprompt`
@@ -29,7 +40,7 @@ with :ref:`faq_troubleshooting_pioblocksprompt`
 Show the version of PlatformIO
 
 .. option::
-    --help
+    --help, -h
 
 Show help for the available options and commands
 
@@ -48,7 +59,6 @@ Commands
     cmd_boards
     cmd_ci
     cmd_init
-    platformio lib <lib/index>
     platformio platforms <platforms/index>
     cmd_run
     cmd_serialports

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

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

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

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

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,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_platforms_install:
 
 platformio platforms install

docs/userguide/platforms/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_platforms_list:
 
 platformio platforms list

docs/userguide/platforms/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_platforms_search:
 
 platformio platforms search

docs/userguide/platforms/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_platforms_show:
 
 platformio platforms show

docs/userguide/platforms/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_platforms_uninstall:
 
 platformio platforms uninstall

docs/userguide/platforms/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_platforms_update:
 
 platformio platforms update

docs/userguide/platforms/index.rst

@@ -1,7 +1,18 @@
+..  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_platforms:
 
-Platforms Manager
-=================
+Platform Manager
+================
 
 To print all available commands and options use:
 

examples/atmelavr-and-arduino/adafruit-blink/README.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.
+
 How to build PlatformIO based project
 =====================================
 

examples/atmelavr-and-arduino/adafruit-blink/lib/readme.txt

@@ -0,0 +1,38 @@
+
+This directory is intended for the project specific (private) libraries.
+PlatformIO will compile them to static libraries and link to executable file.
+
+The source code of each library should be placed in separate directory, like
+"lib/private_lib/[here are source files]".
+
+For example, see how can be organised `Foo` and `Bar` libraries:
+
+|--lib
+|  |--Bar
+|  |  |--docs
+|  |  |--examples
+|  |  |--src
+|  |     |- Bar.c
+|  |     |- Bar.h
+|  |--Foo
+|  |  |- Foo.c
+|  |  |- Foo.h
+|  |- readme.txt --> THIS FILE
+|- platformio.ini
+|--src
+   |- main.c
+
+Then in `src/main.c` you should use:
+
+#include <Foo.h>
+#include <Bar.h>
+
+// rest H/C/CPP code
+
+PlatformIO will find your libraries automatically, configure preprocessor's
+include paths and build them.
+
+See additional options for PlatformIO Library Dependency Finder `lib_*`:
+
+http://docs.platformio.org/en/latest/projectconf.html#lib-install
+

examples/atmelavr-and-arduino/arduino-external-libs/README.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.
+
 How to build PlatformIO based project
 =====================================