forked from platformio/platformio-core
Improve docs for IDE & PlatformIO
This commit is contained in:
Ivan Kravets
64
docs/ide.rst
64
docs/ide.rst
@ -3,62 +3,10 @@
|
|||||||
IDE Integration
|
IDE Integration
|
||||||
===============
|
===============
|
||||||
|
|
||||||
.. contents::
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
Arduino IDE
|
ide/arduino
|
||||||
-----------
|
ide/eclipse
|
||||||
|
ide/energia
|
||||||
.. image:: _static/ide-platformio-arduino.png
|
ide/vim
|
||||||
: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
|
|
||||||
-------
|
|
||||||
|
|
||||||
|
|
||||||
.. 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>`_
|
|
||||||
* `More examples (TI MSP430, TI TIVA and etc) <https://github.com/platformio/platformio/tree/develop/examples/ide-eclipse>`_
|
|
||||||
|
|
||||||
Energia IDE
|
|
||||||
-----------
|
|
||||||
|
|
||||||
.. 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>`_
|
|
||||||
* Code Completion - `YouCompleteMe <https://github.com/Valloric/YouCompleteMe>`_ (see configuration example by **Anthony Ford** `PlatformIO/YouCompleteMe Integration <https://gist.github.com/ajford/f551b2b6fd4d6b6e1ef2>`_)
|
|
||||||
* Syntax checking - `Syntastic <https://github.com/scrooloose/syntastic>`_
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Put to the project directory ``Makefile`` wrapper with contents:
|
|
||||||
|
|
||||||
.. code-block:: make
|
|
||||||
|
|
||||||
# Uncomment lines below if you have problems with $PATH
|
|
||||||
#SHELL := /bin/bash
|
|
||||||
#PATH := /usr/local/bin:$(PATH)
|
|
||||||
|
|
||||||
all:
|
|
||||||
platformio run -t upload
|
|
||||||
|
|
||||||
clean:
|
|
||||||
platformio run -t 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.
|
|
||||||
31
docs/ide/arduino.rst
Normal file
31
docs/ide/arduino.rst
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
.. _ide_arduino:
|
||||||
|
|
||||||
|
Arduino
|
||||||
|
=======
|
||||||
|
|
||||||
|
The open-source `Arduino Software (IDE) <http://arduino.cc/en/main/software>`_
|
||||||
|
makes it easy to write code and upload it to the board. It runs on *Windows,
|
||||||
|
Mac OS X, and Linux*. The environment is written in *Java* and based on
|
||||||
|
*Processing* and other open-source software.
|
||||||
|
|
||||||
|
This software can be used with:
|
||||||
|
|
||||||
|
* :ref:`platform_atmelavr`
|
||||||
|
* :ref:`platform_atmelsam`
|
||||||
|
* :ref:`framework_arduino`
|
||||||
|
|
||||||
|
Refer to the `Arduino Getting Started <http://arduino.cc/en/Guide/HomePage>`_
|
||||||
|
page for Installation instructions.
|
||||||
|
|
||||||
|
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>`_.
|
||||||
|
|
||||||
|
|
||||||
|
Screenshot
|
||||||
|
----------
|
||||||
|
|
||||||
|
.. 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
|
||||||
35
docs/ide/eclipse.rst
Normal file
35
docs/ide/eclipse.rst
Normal file
@ -0,0 +1,35 @@
|
|||||||
|
.. _ide_eclipse:
|
||||||
|
|
||||||
|
Eclipse
|
||||||
|
=======
|
||||||
|
|
||||||
|
The `Eclipse CDT (C/C++ Development Tooling) <https://eclipse.org/cdt/>`_
|
||||||
|
Project provides a fully functional C and C++ Integrated Development
|
||||||
|
Environment based on the Eclipse platform. Features include: support for
|
||||||
|
project creation and managed build for various toolchains, standard make
|
||||||
|
build, source navigation, various source knowledge tools, such as type
|
||||||
|
hierarchy, call graph, include browser, macro definition browser, code editor
|
||||||
|
with syntax highlighting, folding and hyperlink navigation, source code
|
||||||
|
refactoring and code generation, visual debugging tools, including memory,
|
||||||
|
registers, and disassembly viewers.
|
||||||
|
|
||||||
|
This software can be used with:
|
||||||
|
|
||||||
|
* all availalbe :ref:`platforms`
|
||||||
|
* all availalbe :ref:`frameworks`
|
||||||
|
|
||||||
|
Refer to the `CDT Documentation <https://eclipse.org/cdt/documentation.php>`_
|
||||||
|
page for more detailed information.
|
||||||
|
|
||||||
|
Integration
|
||||||
|
-----------
|
||||||
|
|
||||||
|
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>`_.
|
||||||
|
|
||||||
|
`More examples (TI MSP430, TI TIVA, etc.) <https://github.com/platformio/platformio/tree/develop/examples/ide-eclipse>`_
|
||||||
|
|
||||||
|
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
|
||||||
30
docs/ide/energia.rst
Normal file
30
docs/ide/energia.rst
Normal file
@ -0,0 +1,30 @@
|
|||||||
|
.. _ide_energia:
|
||||||
|
|
||||||
|
Energia
|
||||||
|
=======
|
||||||
|
|
||||||
|
The open-source `Energia Software (IDE) <http://energia.nu>`_
|
||||||
|
makes it easy to write code and upload it to the board. It runs on *Windows,
|
||||||
|
Mac OS X, and Linux*. The environment is written in *Java* and based on
|
||||||
|
*Processing* and other open-source software.
|
||||||
|
|
||||||
|
This software can be used with:
|
||||||
|
|
||||||
|
* :ref:`platform_timsp430`
|
||||||
|
* :ref:`platform_titiva`
|
||||||
|
* :ref:`framework_energia`
|
||||||
|
|
||||||
|
Refer to the `Energia Getting Started <hhttp://energia.nu/guide/>`_
|
||||||
|
page for Installation instructions.
|
||||||
|
|
||||||
|
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>`_.
|
||||||
|
|
||||||
|
Screenshot
|
||||||
|
-----------
|
||||||
|
|
||||||
|
.. 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
|
||||||
46
docs/ide/vim.rst
Normal file
46
docs/ide/vim.rst
Normal file
@ -0,0 +1,46 @@
|
|||||||
|
.. _ide_vim:
|
||||||
|
|
||||||
|
VIM
|
||||||
|
===
|
||||||
|
|
||||||
|
`VIM <http://www.vim.org/>`_ is an open-source, powerful and configurable text
|
||||||
|
editor. Vim is designed for use both from a command-line interface and as a
|
||||||
|
standalone application in a graphical user interface.
|
||||||
|
|
||||||
|
This software can be used with:
|
||||||
|
|
||||||
|
* all availalbe :ref:`platforms`
|
||||||
|
* all availalbe :ref:`frameworks`
|
||||||
|
|
||||||
|
Integration
|
||||||
|
-----------
|
||||||
|
|
||||||
|
Recommended bundles:
|
||||||
|
|
||||||
|
* Syntax highlight - `Arduino-syntax-file <https://github.com/vim-scripts/Arduino-syntax-file>`_
|
||||||
|
* Code Completion - `YouCompleteMe <https://github.com/Valloric/YouCompleteMe>`_ (see configuration example by **Anthony Ford** `PlatformIO/YouCompleteMe Integration <https://gist.github.com/ajford/f551b2b6fd4d6b6e1ef2>`_)
|
||||||
|
* Syntax checking - `Syntastic <https://github.com/scrooloose/syntastic>`_
|
||||||
|
|
||||||
|
Put to the project directory ``Makefile`` wrapper with contents:
|
||||||
|
|
||||||
|
.. code-block:: make
|
||||||
|
|
||||||
|
# Uncomment lines below if you have problems with $PATH
|
||||||
|
#SHELL := /bin/bash
|
||||||
|
#PATH := /usr/local/bin:$(PATH)
|
||||||
|
|
||||||
|
all:
|
||||||
|
platformio run -t upload
|
||||||
|
|
||||||
|
clean:
|
||||||
|
platformio run -t 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.
|
||||||
|
|
||||||
|
Screenshot
|
||||||
|
----------
|
||||||
|
|
||||||
|
.. image:: ../_static/ide-platformio-vim.png
|
||||||
Reference in New Issue
Block a user