Merge branch 'release/v0.9.0'

.pylintrc

@@ -38,7 +38,7 @@ 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
+disable=C0103,C0111,E0611,F0401,I0011,R0801,R0903,R0922
 
 
 [REPORTS]

HISTORY.rst

@@ -1,18 +1,40 @@
 Release History
 ===============
 
+0.9.0 (2014-12-01)
+------------------
+
+* Implemented `platformio settings <http://docs.platformio.ikravets.com/en/latest/userguide/cmd_settings.html>`_ command
+* Improved `platformio init <http://docs.platformio.ikravets.com/en/latest/userguide/cmd_init.html>`_ command.
+  Added new option ``--project-dir`` where you can specify another path to
+  directory where new project will be initialized (`issue #31 <https://github.com/ivankravets/platformio/issues/31>`_)
+* Added *Migration Manager* which simplifies process with upgrading to a
+  major release
+* Added *Telemetry Service* which should help us make *PlatformIO* better
+* Implemented *PlatformIO AppState Manager* which allow to have multiple
+  ``.platformio`` states.
+* Refactored *Package Manager*
+* Download Manager: fixed SHA1 verification within *Cygwin Environment*
+  (`issue #26 <https://github.com/ivankravets/platformio/issues/26>`_)
+* Fixed bug with code builder and built-in Arduino libraries
+  (`issue #28 <https://github.com/ivankravets/platformio/issues/28>`_)
+
 0.8.0 (2014-10-19)
 ------------------
 
-* Avoided trademark issues in ``library.json`` with new fields:
-  ``frameworks``, ``platforms`` and ``dependencies`` (`issue #17 <https://github.com/ivankravets/platformio/issues/17>`_)
+* Avoided trademark issues in `library.json <http://docs.platformio.ikravets.com/en/latest/librarymanager/config.html>`_
+  with the new fields: `frameworks <http://docs.platformio.ikravets.com/en/latest/librarymanager/config.html#frameworks>`_,
+  `platforms <http://docs.platformio.ikravets.com/en/latest/librarymanager/config.html#platforms>`_
+  and `dependencies <http://docs.platformio.ikravets.com/en/latest/librarymanager/config.html#dependencies>`_
+  (`issue #17 <https://github.com/ivankravets/platformio/issues/17>`_)
 * Switched logic from "Library Name" to "Library Registry ID" for all
-  ``platformio lib`` commands (install, uninstall, update and etc.)
-* Renamed ``author`` field to ``authors`` and allowed to setup multiple authors
-  per library in ``library.json``
-* Added option to specify "maintainer" status in ``authors`` field
-* New filters/options for ``platformio lib search`` command: ``--framework``
-  and ``--platform``
+  `platformio lib <http://docs.platformio.ikravets.com/en/latest/userguide/lib/index.html>`_
+  commands (install, uninstall, update and etc.)
+* Renamed ``author`` field to `authors <http://docs.platformio.ikravets.com/en/latest/librarymanager/config.html#authors>`_
+  and allowed to setup multiple authors per library in `library.json <http://docs.platformio.ikravets.com/en/latest/librarymanager/config.html>`_
+* Added option to specify "maintainer" status in `authors <http://docs.platformio.ikravets.com/en/latest/librarymanager/config.html#authors>`_ field
+* New filters/options for `platformio lib search <http://docs.platformio.ikravets.com/en/latest/userguide/lib/cmd_search.html>`_
+  command: ``--framework`` and ``--platform``
 
 0.7.1 (2014-10-06)
 ------------------
@@ -25,14 +47,15 @@ Release History
 0.7.0 (2014-09-24)
 ------------------
 
-* Implemented new ``[platformio]`` section for Configuration File with ``home_dir``
+* Implemented new `[platformio] <http://docs.platformio.ikravets.com/en/latest/projectconf.html#platformio>`_
+  section for Configuration File with `home_dir <http://docs.platformio.ikravets.com/en/latest/projectconf.html#home-dir>`_
   option (`issue #14 <https://github.com/ivankravets/platformio/issues/14>`_)
 * Implemented *Library Manager* (`issue #6 <https://github.com/ivankravets/platformio/issues/6>`_)
 
 0.6.0 (2014-08-09)
 ------------------
 
-* Implemented ``serialports monitor`` (`issue #10 <https://github.com/ivankravets/platformio/issues/10>`_)
+* Implemented `platformio serialports monitor <http://docs.platformio.ikravets.com/en/latest/userguide/cmd_serialports.html#platformio-serialports-monitor>`_ (`issue #10 <https://github.com/ivankravets/platformio/issues/10>`_)
 * Fixed an issue ``ImportError: No module named platformio.util`` (`issue #9 <https://github.com/ivankravets/platformio/issues/9>`_)
 * Fixed bug with auto-conversation from Arduino \*.ino to \*.cpp
 
@@ -44,27 +67,31 @@ Release History
 * Added auto-conversation from \*.ino to valid \*.cpp for Arduino/Energia
   frameworks (`issue #7 <https://github.com/ivankravets/platformio/issues/7>`_)
 * Added `Arduino example <https://github.com/ivankravets/platformio/tree/develop/examples/arduino-adafruit-library>`_
-  with external library (Adafruit CC3000)
-* Implemented ``platformio upgrade`` command and "auto-check" for the latest
+  with external library (*Adafruit CC3000*)
+* Implemented `platformio upgrade <http://docs.platformio.ikravets.com/en/latest/userguide/cmd_upgrade.html>`_
+  command and "auto-check" for the latest
   version (`issue #8 <https://github.com/ivankravets/platformio/issues/8>`_)
-* Fixed an issue with "auto-reset" for Raspduino board
+* Fixed an issue with "auto-reset" for *Raspduino* board
 * Fixed a bug with nested libs building
 
 0.4.0 (2014-07-31)
 ------------------
 
-* Implemented ``serialports`` command
+* Implemented `platformio serialports <http://docs.platformio.ikravets.com/en/latest/userguide/cmd_serialports.html>`_ command
 * Allowed to put special build flags only for ``src`` files via
-  ``srcbuild_flags`` environment option
+  `srcbuild_flags <http://docs.platformio.ikravets.com/en/latest/projectconf.html#srcbuild-flags>`_
+  environment option
 * Allowed to override some of settings via system environment variables
   such as: ``$PIOSRCBUILD_FLAGS`` and ``$PIOENVS_DIR``
-* Added ``--upload-port`` option for ``platformio run`` command
+* Added ``--upload-port`` option for `platformio run <http://docs.platformio.ikravets.com/en/latest/userguide/cmd_run.html#cmdoption--upload-port>`_ command
 * Implemented (especially for `SmartAnthill <http://smartanthill.ikravets.com/>`_)
-  ``platformio run -t uploadlazy`` target (no dependencies to framework libs,
-  ELF and etc.)
-* Allowed to skip default packages via ``platformio install --skip-default-package`` flag
-* Added tools for Raspberry Pi platform
-* Added support for Microduino and Raspduino boards in ``atmelavr`` platform
+  `platformio run -t uploadlazy <http://docs.platformio.ikravets.com/en/latest/userguide/cmd_run.html>`_
+  target (no dependencies to framework libs, ELF and etc.)
+* Allowed to skip default packages via `platformio install --skip-default-package <http://docs.platformio.ikravets.com/en/latest/userguide/cmd_install.html#cmdoption--skip-default>`_
+  option
+* Added tools for *Raspberry Pi* platform
+* Added support for *Microduino* and *Raspduino* boards in
+  `atmelavr <http://docs.platformio.ikravets.com/en/latest/platforms/atmelavr.html>`_ platform
 
 
 0.3.1 (2014-06-21)

README.rst

@@ -17,61 +17,107 @@ PlatformIO
     :target: https://pypi.python.org/pypi/platformio/
     :alt:  License
 
-`Website <http://platformio.ikravets.com>`_ |
+`Website + Library Search <http://platformio.ikravets.com>`_ |
 `Documentation <http://docs.platformio.ikravets.com>`_ |
 `Project Examples <https://github.com/ivankravets/platformio/tree/develop/examples>`_ |
-`Bugs/Questions <https://github.com/ivankravets/platformio/issues>`_ |
 `Blog <http://www.ikravets.com/category/computer-life/platformio>`_ |
-`Twitter <https://twitter.com/smartanthill>`_
+`Twitter <https://twitter.com/PlatformIOTool>`_
 
-**PlatformIO** is a cross-platform code builder and library manager for
-*Arduino, MSP430, ARM*.
+.. image:: https://raw.githubusercontent.com/ivankravets/platformio/develop/docs/_static/platformio-logo.png
+    :target: http://platformio.ikravets.com
 
-* `Website + Library Search <http://platformio.ikravets.com>`_
-* `Quickstart <http://docs.platformio.ikravets.com/en/latest/quickstart.html>`_
-* `Installation <http://docs.platformio.ikravets.com/en/latest/installation.html>`_
-* `Project Configuration File <http://docs.platformio.ikravets.com/en/latest/projectconf.html>`_
-* `Platforms & Embedded Boards <http://docs.platformio.ikravets.com/en/latest/platforms/index.html>`_
+`PlatformIO <http://platformio.ikravets.com>`_ is a cross-platform code builder
+and the missing library manager.
+
+* `Get Started <http://platformio.ikravets.com/#!/get-started>`_
+* `Web 2.0 Library Search <http://platformio.ikravets.com/#!/lib>`_
+* `Development Platforms <http://platformio.ikravets.com/#!/platforms>`_
+* `Embedded Boards <http://platformio.ikravets.com/#!/boards>`_
+* `Library Manager <http://docs.platformio.ikravets.com/en/latest/librarymanager/index.html>`_
 * `User Guide <http://docs.platformio.ikravets.com/en/latest/userguide/index.html>`_
 * `IDE Integration <http://docs.platformio.ikravets.com/en/latest/ide.html>`_
 * `Release History <http://docs.platformio.ikravets.com/en/latest/history.html>`_
 
-You have no need to install any *IDE* or compile any tool chains. *PlatformIO*
+You have **no need** to install any *IDE* or compile any tool chains. *PlatformIO*
 has pre-built different development platforms including: compiler, debugger,
 uploader (for embedded boards) and many other useful tools.
 
-**PlatformIO** allows developer to compile the same code with different
-platforms using only one command
+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
+*PlatformIO* beginning from *PC (Mac, Linux, Win)* and ending with credit-card
+sized computers (like *Raspberry Pi*).
+
+Embedded Development. *Easier Than Ever.*
+-----------------------------------------
+*PlatformIO* is well suited for embedded development and has pre-configured
+settings for most popular `Embedded Boards <http://platformio.ikravets.com/#!/boards>`_.
+
+* Colourful `command-line output <https://raw.githubusercontent.com/ivankravets/platformio/develop/examples/platformio-examples.png>`_
+* Built-in `Serial Port Monitor <http://docs.platformio.ikravets.com/en/latest/userguide/cmd_serialports.html#platformio-serialports-monitor>`_
+* Configurable `build -flags/-options <http://docs.platformio.ikravets.com/en/latest/projectconf.html#build-flags>`_
+* Automatic **firmware uploading**
+* Integration with `development environments (IDE) <http://docs.platformio.ikravets.com/en/latest/ide.html>`_
+* Ready for **cloud compilers**
+* Pre-built tool chains, frameworks for the popular `Hardware Platforms <http://platformio.ikravets.com/#!/platforms>`_
+
+.. image:: https://raw.githubusercontent.com/ivankravets/platformio-web/develop/app/images/platformio-embedded-development.png
+    :target: http://platformio.ikravets.com
+    :alt:  PlatformIO Embedded Development Process
+
+The Missing Library Manager. *It's here!*
+-----------------------------------------
+*PlatformIO Library Manager* is the missing library manager for development
+platforms which allows you to organize and have up-to-date external libraries.
+
+* Friendly `Command-Line Interface <http://docs.platformio.ikravets.com/en/latest/librarymanager/index.html>`_
+* Modern `Web 2.0 Library Search <http://platformio.ikravets.com/#!/lib>`_
+* Open Source `Library Registry API <https://github.com/ivankravets/platformio-api>`_
+* Library Crawler based on `library.json <http://docs.platformio.ikravets.com/en/latest/librarymanager/config.html>`_
+  specification
+* Library **dependency management**
+* Automatic library updating
+
+.. image:: https://raw.githubusercontent.com/ivankravets/platformio-web/develop/app/images/platformio-library-manager.png
+    :target: http://platformio.ikravets.com
+    :alt:  PlatformIO Library Manager Architecture
+
+Smart Code Builder. *Fast and Reliable.*
+----------------------------------------
+*PlatformIO Code Builder* is built-on a next-generation software construction
+tool named `SCons <http://www.scons.org/>`_. Think of *SCons* as an improved,
+cross-platform substitute for the classic *Make* utility.
+
+* Reliable, automatic *dependency analysis*
+* Reliable detection of *build changes*
+* Improved support for *parallel builds*
+* Ability to share *built files in a cache*
+* Lookup for external libraries which are installed via `Library Manager <http://docs.platformio.ikravets.com/en/latest/librarymanager/index.html>`_
+
+.. image:: https://raw.githubusercontent.com/ivankravets/platformio-web/develop/app/images/platformio-scons-builder.png
+    :target: http://platformio.ikravets.com
+    :alt:  PlatformIO Code Builder Architecture
+
+Single source code. *Multiple platforms.*
+-----------------------------------------
+*PlatformIO* allows developer to compile the same code with different
+development platforms using the *Only One Command*
 `platformio run <http://docs.platformio.ikravets.com/en/latest/userguide/cmd_run.html>`_.
 This happens due to
-`Project Configuration File <http://docs.platformio.ikravets.com/en/latest/projectconf.html>`_
-where you can setup different environments with specific
-options: platform type, firmware uploading settings, pre-built framework
-and many more.
-
-.. image:: examples/platformio-examples.png
-    :target: https://github.com/ivankravets/platformio/raw/develop/examples/platformio-examples.png
-    :alt:  Examples
-    :width: 730px
-
-**PlatformIO** is well suited for **embedded development**. It can:
-
-* Automatically analyse dependency
-* Reliably detect build changes
-* Build framework or library source code to static library
-* Build *ELF* (executable and linkable firmware)
-* Convert *ELF* to *HEX* or *BIN* file
-* Extract *EEPROM* data
-* Upload firmware to your device
+`Project Configuration File (platformio.ini) <http://docs.platformio.ikravets.com/en/latest/projectconf.html>`_
+where you can setup different environments with specific options (platform
+type, firmware uploading settings, pre-built framework, build flags and many
+more).
 
 It has support for many popular embedded platforms like these:
 
-* ``atmelavr`` `Atmel AVR <http://en.wikipedia.org/wiki/Atmel_AVR>`_
-  (including `Arduino <http://www.arduino.cc>`_ based boards)
-* ``timsp430`` `TI MSP430 <http://www.ti.com/lsds/ti/microcontroller/16-bit_msp430/overview.page>`_
-  (including `MSP430 LaunchPads <http://www.ti.com/ww/en/launchpad/launchpads-msp430.html>`_)
-* ``titiva`` `TI TIVA C <http://www.ti.com/lsds/ti/microcontroller/tiva_arm_cortex/c_series/overview.page>`_
-  (including `TIVA C Series LaunchPads <http://www.ti.com/ww/en/launchpad/launchpads-connected.html>`_)
+* ``atmelavr`` `Atmel AVR <http://platformio.ikravets.com/#!/platforms/atmelavr>`_
+  (including *Arduino*-based boards, *Microduino, Raspduino, Teensy*)
+* ``timsp430`` `TI MSP430 <http://platformio.ikravets.com/#!/platforms/timsp430>`_
+  (including *MSP430* LaunchPads)
+* ``titiva`` `TI TIVA C <http://platformio.ikravets.com/#!/platforms/titiva>`_
+  (including *TIVA C* Series LaunchPads)
 
 
 Licence
@@ -80,4 +126,3 @@ Licence
 Copyright (C) 2014 Ivan Kravets
 
 Licenced under the MIT Licence.
-

docs/ide.rst

@@ -6,20 +6,33 @@ IDE Integration
 Arduino IDE
 -----------
 
-`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>`_
+.. image:: _static/ide-platformio-arduino.png
+    :target: http://www.ikravets.com/computer-life/platformio/2014/10/07/integration-of-platformio-library-manager-to-arduino-and-energia-ides
+
+* `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>`_
 
 Eclipse
 -------
-`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>`_
+
+
+.. 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
+
+* `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>`_
 
 Energia IDE
 -----------
 
-`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>`_
+.. image:: _static/ide-platformio-energia.png
+    :target: http://www.ikravets.com/computer-life/platformio/2014/10/07/integration-of-platformio-library-manager-to-arduino-and-energia-ides
+
+* `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>`_
 
 VIM
 ---
 
+.. image:: _static/ide-platformio-vim.png
+
 Recommended bundles:
 
 * Syntax highlight - `Arduino-syntax-file <https://github.com/vim-scripts/Arduino-syntax-file>`_

docs/index.rst

@@ -1,12 +1,15 @@
-PlatformIO: A cross-platform code builder and library manager for Arduino, MSP430, ARM
-======================================================================================
+PlatformIO: A cross-platform code builder and the missing library manager
+=========================================================================
+
+.. image:: _static/platformio-logo.png
+    :target: http://platformio.ikravets.com
 
 `Website + Library Search <http://platformio.ikravets.com>`_ |
 `Project Examples <https://github.com/ivankravets/platformio/tree/develop/examples>`_ |
 `Source Code <https://github.com/ivankravets/platformio>`_ |
-`Bugs/Questions <https://github.com/ivankravets/platformio/issues>`_ |
+`Issues <https://github.com/ivankravets/platformio/issues>`_ |
 `Blog <http://www.ikravets.com/category/computer-life/platformio>`_ |
-`Twitter <https://twitter.com/smartanthill>`_
+`Twitter <https://twitter.com/PlatformIOTool>`_
 
 You have no need to install any *IDE* or compile any tool chains. *PlatformIO*
 has pre-built different development platforms including: compiler, debugger,
@@ -27,9 +30,7 @@ instruments.
 * Automatically analyse dependency
 * Reliably detect build changes
 * Build framework or library source code to static library
-* Build *ELF* (executable and linkable firmware)
-* Convert *ELF* to *HEX* or *BIN* file
-* Extract *EEPROM* data
+* Lookup for external libraries which are installed via :ref:`librarymanager`
 * Upload firmware to your device