mirror of
https://github.com/platformio/platformio-core.git
synced 2025-07-31 02:27:13 +02:00
Add logo, improve texts
This commit is contained in:
39
README.rst
39
README.rst
@ -17,21 +17,23 @@ PlatformIO
|
|||||||
:target: https://pypi.python.org/pypi/platformio/
|
:target: https://pypi.python.org/pypi/platformio/
|
||||||
:alt: License
|
:alt: License
|
||||||
|
|
||||||
`Website <http://platformio.ikravets.com>`_ |
|
`Website + Library Search <http://platformio.ikravets.com>`_ |
|
||||||
`Documentation <http://docs.platformio.ikravets.com>`_ |
|
`Documentation <http://docs.platformio.ikravets.com>`_ |
|
||||||
`Project Examples <https://github.com/ivankravets/platformio/tree/develop/examples>`_ |
|
`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>`_ |
|
`Blog <http://www.ikravets.com/category/computer-life/platformio>`_ |
|
||||||
`Twitter <https://twitter.com/PlatformIOTool>`_
|
`Twitter <https://twitter.com/PlatformIOTool>`_
|
||||||
|
|
||||||
**PlatformIO** is a cross-platform code builder and library manager for
|
.. image:: https://raw.githubusercontent.com/ivankravets/platformio/develop/docs/_static/platformio-logo.png
|
||||||
*Arduino, MSP430, ARM*.
|
:target: http://platformio.ikravets.com
|
||||||
|
|
||||||
* `Website + Library Search <http://platformio.ikravets.com>`_
|
`PlatformIO <http://platformio.ikravets.com>`_ is a cross-platform code builder
|
||||||
* `Quickstart <http://docs.platformio.ikravets.com/en/latest/quickstart.html>`_
|
and the missing library manager.
|
||||||
* `Installation <http://docs.platformio.ikravets.com/en/latest/installation.html>`_
|
|
||||||
* `Project Configuration File <http://docs.platformio.ikravets.com/en/latest/projectconf.html>`_
|
* `Get Started <http://platformio.ikravets.com/#!/get-started>`_
|
||||||
* `Platforms & Embedded Boards <http://docs.platformio.ikravets.com/en/latest/platforms/index.html>`_
|
* `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>`_
|
* `User Guide <http://docs.platformio.ikravets.com/en/latest/userguide/index.html>`_
|
||||||
* `IDE Integration <http://docs.platformio.ikravets.com/en/latest/ide.html>`_
|
* `IDE Integration <http://docs.platformio.ikravets.com/en/latest/ide.html>`_
|
||||||
* `Release History <http://docs.platformio.ikravets.com/en/latest/history.html>`_
|
* `Release History <http://docs.platformio.ikravets.com/en/latest/history.html>`_
|
||||||
@ -50,7 +52,7 @@ options: platform type, firmware uploading settings, pre-built framework
|
|||||||
and many more.
|
and many more.
|
||||||
|
|
||||||
.. image:: examples/platformio-examples.png
|
.. 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
|
:alt: Examples
|
||||||
:width: 730px
|
:width: 730px
|
||||||
|
|
||||||
@ -59,19 +61,18 @@ and many more.
|
|||||||
* Automatically analyse dependency
|
* Automatically analyse dependency
|
||||||
* Reliably detect build changes
|
* Reliably detect build changes
|
||||||
* Build framework or library source code to static library
|
* 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
|
* Upload firmware to your device
|
||||||
|
* Lookup for external libraries which are installed via
|
||||||
|
`Library Manager <http://docs.platformio.ikravets.com/en/latest/librarymanager/index.html>`_
|
||||||
|
|
||||||
It has support for many popular embedded platforms like these:
|
It has support for many popular embedded platforms like these:
|
||||||
|
|
||||||
* ``atmelavr`` `Atmel AVR <http://en.wikipedia.org/wiki/Atmel_AVR>`_
|
* ``atmelavr`` `Atmel AVR <http://platformio.ikravets.com/#!/platforms/atmelavr>`_
|
||||||
(including `Arduino <http://www.arduino.cc>`_ based boards)
|
(including Arduino-based boards)
|
||||||
* ``timsp430`` `TI MSP430 <http://www.ti.com/lsds/ti/microcontroller/16-bit_msp430/overview.page>`_
|
* ``timsp430`` `TI MSP430 <http://platformio.ikravets.com/#!/platforms/timsp430>`_
|
||||||
(including `MSP430 LaunchPads <http://www.ti.com/ww/en/launchpad/launchpads-msp430.html>`_)
|
(including MSP430 LaunchPads)
|
||||||
* ``titiva`` `TI TIVA C <http://www.ti.com/lsds/ti/microcontroller/tiva_arm_cortex/c_series/overview.page>`_
|
* ``titiva`` `TI TIVA C <http://platformio.ikravets.com/#!/platforms/titiva>`_
|
||||||
(including `TIVA C Series LaunchPads <http://www.ti.com/ww/en/launchpad/launchpads-connected.html>`_)
|
(including TIVA C Series LaunchPads)
|
||||||
|
|
||||||
|
|
||||||
Licence
|
Licence
|
||||||
|
BIN
docs/_static/platformio-logo.png
vendored
Normal file
BIN
docs/_static/platformio-logo.png
vendored
Normal file
Binary file not shown.
After Width: | Height: | Size: 10 KiB |
@ -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>`_ |
|
`Website + Library Search <http://platformio.ikravets.com>`_ |
|
||||||
`Project Examples <https://github.com/ivankravets/platformio/tree/develop/examples>`_ |
|
`Project Examples <https://github.com/ivankravets/platformio/tree/develop/examples>`_ |
|
||||||
`Source Code <https://github.com/ivankravets/platformio>`_ |
|
`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>`_ |
|
`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*
|
You have no need to install any *IDE* or compile any tool chains. *PlatformIO*
|
||||||
has pre-built different development platforms including: compiler, debugger,
|
has pre-built different development platforms including: compiler, debugger,
|
||||||
@ -27,9 +30,7 @@ instruments.
|
|||||||
* Automatically analyse dependency
|
* Automatically analyse dependency
|
||||||
* Reliably detect build changes
|
* Reliably detect build changes
|
||||||
* Build framework or library source code to static library
|
* Build framework or library source code to static library
|
||||||
* Build *ELF* (executable and linkable firmware)
|
* Lookup for external libraries which are installed via :ref:`librarymanager`
|
||||||
* Convert *ELF* to *HEX* or *BIN* file
|
|
||||||
* Extract *EEPROM* data
|
|
||||||
* Upload firmware to your device
|
* Upload firmware to your device
|
||||||
|
|
||||||
|
|
||||||
|
@ -4,18 +4,17 @@
|
|||||||
library.json
|
library.json
|
||||||
============
|
============
|
||||||
|
|
||||||
*PlatformIO*-suitable library should be defined by a manifest file
|
``library.json`` is a manifest file of development library.
|
||||||
``library.json`` in a `JSON-style <http://en.wikipedia.org/wiki/JSON>`_.
|
|
||||||
A data in ``library.json`` should be represented via
|
|
||||||
`associative array <http://en.wikipedia.org/wiki/Associative_array>`_
|
|
||||||
(name/value pairs). An order doesn't matter.
|
|
||||||
|
|
||||||
The allowable fields (names from pairs) are described below. The fields
|
Initially it was
|
||||||
(:ref:`libjson_name`, :ref:`libjson_description`, :ref:`libjson_keywords`
|
developed for :ref:`librarymanager`, but later was accepted by worldwide embedded
|
||||||
and :ref:`libjson_authors`)
|
community like a **standard library specification**.
|
||||||
will be displayed in the search results at the :ref:`cmd_lib_search` (*CLI*)
|
|
||||||
and at the `WebSite <http://platformio.ikravets.com/#!/lib>`_.
|
A data in ``library.json`` should be represented
|
||||||
Also, they can be used for searching for libraries.
|
in `JSON-style <http://en.wikipedia.org/wiki/JSON>`_ via
|
||||||
|
`associative array <http://en.wikipedia.org/wiki/Associative_array>`_
|
||||||
|
(name/value pairs). An order doesn't matter. The allowable fields
|
||||||
|
(names from pairs) are described below.
|
||||||
|
|
||||||
.. contents::
|
.. contents::
|
||||||
|
|
||||||
|
@ -17,8 +17,8 @@ You don't need to bother for finding the latest version of library. Due to
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
creating
|
|
||||||
config
|
config
|
||||||
|
creating
|
||||||
User Guide <../userguide/lib/index.rst>
|
User Guide <../userguide/lib/index.rst>
|
||||||
|
|
||||||
.. [#] Inspired by `npm <https://www.npmjs.org>`_ and `bower
|
.. [#] Inspired by `npm <https://www.npmjs.org>`_ and `bower
|
||||||
|
@ -3,6 +3,10 @@
|
|||||||
Quickstart
|
Quickstart
|
||||||
==========
|
==========
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
Please read `Get Started <http://platformio.ikravets.com/#!/get-started>`_
|
||||||
|
article from the official WebSite.
|
||||||
|
|
||||||
First, :ref:`Install PlatformIO <installation>`.
|
First, :ref:`Install PlatformIO <installation>`.
|
||||||
|
|
||||||
Print all available development platforms for installing
|
Print all available development platforms for installing
|
||||||
|
Reference in New Issue
Block a user