Files
platformio-core/docs/index.rst

51 lines
1.7 KiB
ReStructuredText
Raw Normal View History

2014-11-07 22:14:44 +02:00
PlatformIO: A cross-platform code builder and the missing library manager
=========================================================================
.. image:: _static/platformio-logo.png
:target: http://platformio.org
2014-08-04 09:23:57 +03:00
`Website + Library Search <http://platformio.org>`_ |
2014-08-09 16:31:20 +03:00
`Project Examples <https://github.com/ivankravets/platformio/tree/develop/examples>`_ |
`Source Code <https://github.com/ivankravets/platformio>`_ |
2014-11-07 22:14:44 +02:00
`Issues <https://github.com/ivankravets/platformio/issues>`_ |
2014-08-09 16:31:20 +03:00
`Blog <http://www.ikravets.com/category/computer-life/platformio>`_ |
`Twitter <https://twitter.com/PlatformIO_Org>`_
2014-08-09 16:31:20 +03:00
You have no need to install any *IDE* or compile any tool chains. *PlatformIO*
2014-08-04 09:23:57 +03:00
has pre-built different development platforms including: compiler, debugger,
2014-08-09 16:31:20 +03:00
uploader (for embedded) and many other useful tools.
2014-08-04 09:23:57 +03:00
**PlatformIO** allows developer to compile the same code with different
2014-08-09 16:31:20 +03:00
platforms using only one command :ref:`cmd_run`. This happens due to
:ref:`projectconf` where you can setup different environments with specific
options: platform type, firmware uploading settings, pre-built framework
and many more.
2014-08-04 09:23:57 +03:00
Each platform consists of packages which are located in own repository.
2014-08-09 16:31:20 +03:00
Due to :ref:`cmd_update` command you will have up-to-date development
2014-08-04 09:23:57 +03:00
instruments.
**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
2014-11-07 22:14:44 +02:00
* Lookup for external libraries which are installed via :ref:`librarymanager`
2014-08-04 09:23:57 +03:00
* Upload firmware to your device
2014-08-09 16:31:20 +03:00
Contents
--------
2014-08-04 09:23:57 +03:00
.. toctree::
2014-08-09 16:31:20 +03:00
:maxdepth: 2
quickstart
installation
projectconf
platforms/index
2014-09-06 13:44:45 +03:00
librarymanager/index
2014-08-09 16:31:20 +03:00
userguide/index
ide
history