From d3f03f3fc81f74a9b09c3e865bcc225ee9735d83 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Mon, 22 Feb 2016 01:23:55 +0200 Subject: [PATCH] Minor updates to IDE docs --- docs/ide/atom.rst | 21 ++++++++++----------- docs/quickstart.rst | 2 +- 2 files changed, 11 insertions(+), 12 deletions(-) diff --git a/docs/ide/atom.rst b/docs/ide/atom.rst index 4bae4431..8233bbd7 100644 --- a/docs/ide/atom.rst +++ b/docs/ide/atom.rst @@ -23,11 +23,10 @@ PlatformIO IDE is the next generation integrated development environment for IoT - 15+ development platforms - 10+ frameworks -* C/C++ Intelligent code completion -* C/C++ Smart code linter for super-fast coding +* C/C++ Intelligent Code Completion +* C/C++ Smart Code Linter for rapid professional development * Library Manager for the hundreds popular libraries * Multi-projects workflow with multiple panes -* Multiple panes * Themes support with dark and light colors * Serial Port Monitor * Built-in Terminal with :ref:`PlatformIO CLI ` tool (``pio``, ``platformio``) @@ -71,7 +70,7 @@ Manual Installation - `Other platforms `_ -2. Open Atom Package Manager and search for `platformio-ide `_ +2. Open Atom Package Manager and install `platformio-ide `_ Atom package - **Mac OS X**: ``Menu: Atom > Preferences > Install`` - **Windows**: ``Menu: File > Settings > Install`` @@ -179,8 +178,9 @@ Terminal and run ``clang --version``. If ``clang`` is not installed, then instal Smart Code Linter ~~~~~~~~~~~~~~~~~ -PlatformIO IDE uses PlatformIO's pre-built GCC toolchains for Smart Code Linter. The -configuration data are located in ``.gcc-flags.json``. This file will be +PlatformIO IDE uses PlatformIO's pre-built GCC toolchains for Smart Code Linter +and rapid professional development. +The configuration data are located in ``.gcc-flags.json``. This file will be automatically created and preconfigured when you initialize project using ``Menu: PlatformIO > Initialize new PlatformIO Project or update existing...``. @@ -270,16 +270,15 @@ Force Arduino file as C++ To force Smart Code Linter to use Arduino files as C++ please -1. Open ``.gcc-flags.json`` file from the Initialized/Imported project. Add - ``-x c`` option at the beginning to ``gccDefaultCFlags`` and ``gccDefaultCppFlags`` - fields: +1. Open ``.gcc-flags.json`` file from the Initialized/Imported project and add + ``-x c++`` flag at the beginning of the value of ``gccDefaultCppFlags`` field: .. code-block:: json { "execPath": "...", - "gccDefaultCFlags": "-x c -fsyntax-only ...", - "gccDefaultCppFlags": "-x c -fsyntax-only ...", + "gccDefaultCFlags": "...", + "gccDefaultCppFlags": "-x c++ -fsyntax-only ...", "gccErrorLimit": 15, "gccIncludePaths": "...", "gccSuppressWarnings": false diff --git a/docs/quickstart.rst b/docs/quickstart.rst index f1975a75..45b2cd71 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -26,7 +26,7 @@ Please follow to the Quickstart section of :ref:`ide_atom`. PlatformIO CLI -------------- -1. `Install PlatformIO CLI `_. +1. :ref:`installation`. 2. Find board ``type`` using `Embedded Boards Explorer `_ or via :ref:`cmd_boards` command.