mirror of
https://github.com/platformio/platformio-core.git
synced 2025-11-03 23:41:38 +01:00
52 lines
1.6 KiB
ReStructuredText
52 lines
1.6 KiB
ReStructuredText
.. _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 available :ref:`platforms`
|
|
* all available :ref:`frameworks`
|
|
|
|
Integration
|
|
-----------
|
|
|
|
.. note::
|
|
Please verify that folder where is located ``platformio`` program is added
|
|
to `PATH (wiki) <https://en.wikipedia.org/wiki/PATH_(variable)>`_ environment
|
|
variable. See FAQ: :ref:`faq_troubleshooting_pionotfoundinpath`.
|
|
|
|
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 --force run --target upload
|
|
|
|
clean:
|
|
platformio --force run --target 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
|