Minor updates to IDE docs

This commit is contained in:
Ivan Kravets
2016-02-22 01:23:55 +02:00
parent 17c9e8ddc1
commit d3f03f3fc8
2 changed files with 11 additions and 12 deletions

View File

@ -23,11 +23,10 @@ PlatformIO IDE is the next generation integrated development environment for IoT
- 15+ development platforms - 15+ development platforms
- 10+ frameworks - 10+ frameworks
* C/C++ Intelligent code completion * C/C++ Intelligent Code Completion
* C/C++ Smart code linter for super-fast coding * C/C++ Smart Code Linter for rapid professional development
* Library Manager for the hundreds popular libraries * Library Manager for the hundreds popular libraries
* Multi-projects workflow with multiple panes * Multi-projects workflow with multiple panes
* Multiple panes
* Themes support with dark and light colors * Themes support with dark and light colors
* Serial Port Monitor * Serial Port Monitor
* Built-in Terminal with :ref:`PlatformIO CLI <userguide>` tool (``pio``, ``platformio``) * Built-in Terminal with :ref:`PlatformIO CLI <userguide>` tool (``pio``, ``platformio``)
@ -71,7 +70,7 @@ Manual Installation
- `Other platforms <https://github.com/atom/atom/releases/latest>`_ - `Other platforms <https://github.com/atom/atom/releases/latest>`_
2. Open Atom Package Manager and search for `platformio-ide <https://atom.io/packages/platformio-ide>`_ 2. Open Atom Package Manager and install `platformio-ide <https://atom.io/packages/platformio-ide>`_ Atom package
- **Mac OS X**: ``Menu: Atom > Preferences > Install`` - **Mac OS X**: ``Menu: Atom > Preferences > Install``
- **Windows**: ``Menu: File > Settings > 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 Smart Code Linter
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
PlatformIO IDE uses PlatformIO's pre-built GCC toolchains for Smart Code Linter. The PlatformIO IDE uses PlatformIO's pre-built GCC toolchains for Smart Code Linter
configuration data are located in ``.gcc-flags.json``. This file will be 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 automatically created and preconfigured when you initialize project using
``Menu: PlatformIO > Initialize new PlatformIO Project or update existing...``. ``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 To force Smart Code Linter to use Arduino files as C++ please
1. Open ``.gcc-flags.json`` file from the Initialized/Imported project. Add 1. Open ``.gcc-flags.json`` file from the Initialized/Imported project and add
``-x c`` option at the beginning to ``gccDefaultCFlags`` and ``gccDefaultCppFlags`` ``-x c++`` flag at the beginning of the value of ``gccDefaultCppFlags`` field:
fields:
.. code-block:: json .. code-block:: json
{ {
"execPath": "...", "execPath": "...",
"gccDefaultCFlags": "-x c -fsyntax-only ...", "gccDefaultCFlags": "...",
"gccDefaultCppFlags": "-x c -fsyntax-only ...", "gccDefaultCppFlags": "-x c++ -fsyntax-only ...",
"gccErrorLimit": 15, "gccErrorLimit": 15,
"gccIncludePaths": "...", "gccIncludePaths": "...",
"gccSuppressWarnings": false "gccSuppressWarnings": false

View File

@ -26,7 +26,7 @@ Please follow to the Quickstart section of :ref:`ide_atom`.
PlatformIO CLI PlatformIO CLI
-------------- --------------
1. `Install PlatformIO CLI <installation.html>`_. 1. :ref:`installation`.
2. Find board ``type`` using `Embedded Boards Explorer <http://platformio.org/#!/boards>`_ 2. Find board ``type`` using `Embedded Boards Explorer <http://platformio.org/#!/boards>`_
or via :ref:`cmd_boards` command. or via :ref:`cmd_boards` command.