From 3d0aad6df8cbc532a77d8664f2a877dad3afceee Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Wed, 6 Jan 2016 16:52:22 +0200 Subject: [PATCH] Add support for completions to Atom text editor using ".clang_complete" --- HISTORY.rst | 1 + docs/ide/atom.rst | 24 ++++++++++++++++++++++-- 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/HISTORY.rst b/HISTORY.rst index adf1d2a5..3c001f49 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -9,6 +9,7 @@ PlatformIO 2.0 * Initial support for Arduino Zero board (`issue #356 `_) +* Added support for completions to Atom text editor using ``.clang_complete`` * Generate default targets for `supported IDE `__ (CLion, Eclipse IDE, Emacs, Sublime Text, VIM): Build, Clean, Upload, Upload SPIFFS image, Upload using Programmer, Update installed diff --git a/docs/ide/atom.rst b/docs/ide/atom.rst index 424c1e55..abf3258a 100644 --- a/docs/ide/atom.rst +++ b/docs/ide/atom.rst @@ -31,8 +31,28 @@ page for more detailed information. Integration ----------- -Using `Atom Packages `_ -please install `platomformio `_ package. +There is Atom based `platomformio `_ +package which can be installed `Using Atom Packages `_. + +If you have ``clang`` installed in your system (is installed by default in Mac +OS X), you can enable completions using +`autocomplete-clang `_ package. +This package requires ``.clang_complete`` file and PlatformIO can generate it. + +Choose board ``type`` using :ref:`cmd_boards` or `Embedded Boards Explorer `_ +command and generate project via :option:`platformio init --ide` command: + +.. code-block:: shell + + platformio init --ide atom --board %TYPE% + + # For example, generate project for Arduino UNO + platformio init --ide atom --board uno + +.. warning:: + The libraries which are added, installed or used in the project + after generating process wont be reflected in IDE. To fix it you + need to reinitialize project using :ref:`cmd_init` (repeat it). Articles / Manuals ------------------