diff --git a/docs/ide.rst b/docs/ide.rst index af573259..61e39986 100644 --- a/docs/ide.rst +++ b/docs/ide.rst @@ -3,62 +3,10 @@ IDE Integration =============== -.. contents:: +.. toctree:: + :maxdepth: 2 -Arduino IDE ------------ - -.. 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 `_ - -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 `_ -* `More examples (TI MSP430, TI TIVA and etc) `_ - -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 `_ - -VIM ---- - -.. image:: _static/ide-platformio-vim.png - -Recommended bundles: - -* Syntax highlight - `Arduino-syntax-file `_ -* Code Completion - `YouCompleteMe `_ (see configuration example by **Anthony Ford** `PlatformIO/YouCompleteMe Integration `_) -* Syntax checking - `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. + ide/arduino + ide/eclipse + ide/energia + ide/vim \ No newline at end of file diff --git a/docs/ide/arduino.rst b/docs/ide/arduino.rst new file mode 100644 index 00000000..7cd3b3a5 --- /dev/null +++ b/docs/ide/arduino.rst @@ -0,0 +1,31 @@ +.. _ide_arduino: + +Arduino +======= + +The open-source `Arduino Software (IDE) `_ +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 `_ +page for Installation instructions. + +Integration +----------- + +More detailed information is located in PlatformIO blog: +`Integration of PlatformIO library manager to Arduino IDE `_. + + +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 diff --git a/docs/ide/eclipse.rst b/docs/ide/eclipse.rst new file mode 100644 index 00000000..6fd8fae1 --- /dev/null +++ b/docs/ide/eclipse.rst @@ -0,0 +1,35 @@ +.. _ide_eclipse: + +Eclipse +======= + +The `Eclipse CDT (C/C++ Development Tooling) `_ +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 `_ +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 `_. + +`More examples (TI MSP430, TI TIVA, etc.) `_ + +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 diff --git a/docs/ide/energia.rst b/docs/ide/energia.rst new file mode 100644 index 00000000..776da868 --- /dev/null +++ b/docs/ide/energia.rst @@ -0,0 +1,30 @@ +.. _ide_energia: + +Energia +======= + +The open-source `Energia Software (IDE) `_ +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 `_ +page for Installation instructions. + +Integration +----------- + +More detailed information is located in PlatformIO blog: +`Integration of PlatformIO library manager to Energia IDE `_. + +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 diff --git a/docs/ide/vim.rst b/docs/ide/vim.rst new file mode 100644 index 00000000..1840e510 --- /dev/null +++ b/docs/ide/vim.rst @@ -0,0 +1,46 @@ +.. _ide_vim: + +VIM +=== + +`VIM `_ 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 `_ +* Code Completion - `YouCompleteMe `_ (see configuration example by **Anthony Ford** `PlatformIO/YouCompleteMe Integration `_) +* Syntax checking - `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