diff --git a/README.rst b/README.rst index c4716782..6c4abe0f 100644 --- a/README.rst +++ b/README.rst @@ -17,21 +17,23 @@ PlatformIO :target: https://pypi.python.org/pypi/platformio/ :alt: License -`Website `_ | +`Website + Library Search `_ | `Documentation `_ | `Project Examples `_ | -`Bugs/Questions `_ | `Blog `_ | `Twitter `_ -**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 `_ -* `Quickstart `_ -* `Installation `_ -* `Project Configuration File `_ -* `Platforms & Embedded Boards `_ +`PlatformIO `_ is a cross-platform code builder +and the missing library manager. + +* `Get Started `_ +* `Web 2.0 Library Search `_ +* `Development Platforms `_ +* `Embedded Boards `_ +* `Library Manager `_ * `User Guide `_ * `IDE Integration `_ * `Release History `_ @@ -50,7 +52,7 @@ 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 + :target: https://raw.githubusercontent.com/ivankravets/platformio/develop/examples/platformio-examples.png :alt: Examples :width: 730px @@ -59,19 +61,18 @@ and many more. * 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 +* Lookup for external libraries which are installed via + `Library Manager `_ It has support for many popular embedded platforms like these: -* ``atmelavr`` `Atmel AVR `_ - (including `Arduino `_ based boards) -* ``timsp430`` `TI MSP430 `_ - (including `MSP430 LaunchPads `_) -* ``titiva`` `TI TIVA C `_ - (including `TIVA C Series LaunchPads `_) +* ``atmelavr`` `Atmel AVR `_ + (including Arduino-based boards) +* ``timsp430`` `TI MSP430 `_ + (including MSP430 LaunchPads) +* ``titiva`` `TI TIVA C `_ + (including TIVA C Series LaunchPads) Licence diff --git a/docs/_static/platformio-logo.png b/docs/_static/platformio-logo.png new file mode 100644 index 00000000..62bde5ca Binary files /dev/null and b/docs/_static/platformio-logo.png differ diff --git a/docs/index.rst b/docs/index.rst index a7b2254e..b72528a6 100644 --- a/docs/index.rst +++ b/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 `_ | `Project Examples `_ | `Source Code `_ | -`Bugs/Questions `_ | +`Issues `_ | `Blog `_ | -`Twitter `_ +`Twitter `_ 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 diff --git a/docs/librarymanager/config.rst b/docs/librarymanager/config.rst index 62562296..fe6e573f 100644 --- a/docs/librarymanager/config.rst +++ b/docs/librarymanager/config.rst @@ -4,18 +4,17 @@ library.json ============ -*PlatformIO*-suitable library should be defined by a manifest file -``library.json`` in a `JSON-style `_. -A data in ``library.json`` should be represented via -`associative array `_ -(name/value pairs). An order doesn't matter. +``library.json`` is a manifest file of development library. -The allowable fields (names from pairs) are described below. The fields -(:ref:`libjson_name`, :ref:`libjson_description`, :ref:`libjson_keywords` -and :ref:`libjson_authors`) -will be displayed in the search results at the :ref:`cmd_lib_search` (*CLI*) -and at the `WebSite `_. -Also, they can be used for searching for libraries. +Initially it was +developed for :ref:`librarymanager`, but later was accepted by worldwide embedded +community like a **standard library specification**. + +A data in ``library.json`` should be represented +in `JSON-style `_ via +`associative array `_ +(name/value pairs). An order doesn't matter. The allowable fields +(names from pairs) are described below. .. contents:: diff --git a/docs/librarymanager/index.rst b/docs/librarymanager/index.rst index 774e90e0..5dcc323a 100644 --- a/docs/librarymanager/index.rst +++ b/docs/librarymanager/index.rst @@ -17,8 +17,8 @@ You don't need to bother for finding the latest version of library. Due to .. toctree:: :maxdepth: 2 - creating config + creating User Guide <../userguide/lib/index.rst> .. [#] Inspired by `npm `_ and `bower diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 6ad1551c..f211fdb2 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -3,6 +3,10 @@ Quickstart ========== +.. note:: + Please read `Get Started `_ + article from the official WebSite. + First, :ref:`Install PlatformIO `. Print all available development platforms for installing