forked from platformio/platformio-core
Update docs for PlatformIO IDE
This commit is contained in:
BIN
docs/_static/ide-atom-platformio-install.png
vendored
Normal file
BIN
docs/_static/ide-atom-platformio-install.png
vendored
Normal file
Binary file not shown.
After Width: | Height: | Size: 240 KiB |
BIN
docs/_static/ide-atom-platformio-menu-item.png
vendored
BIN
docs/_static/ide-atom-platformio-menu-item.png
vendored
Binary file not shown.
Before Width: | Height: | Size: 152 KiB After Width: | Height: | Size: 175 KiB |
BIN
docs/_static/ide-atom-platformio-toolbar.png
vendored
Normal file
BIN
docs/_static/ide-atom-platformio-toolbar.png
vendored
Normal file
Binary file not shown.
After Width: | Height: | Size: 43 KiB |
BIN
docs/_static/ide-atom-platformio.png
vendored
BIN
docs/_static/ide-atom-platformio.png
vendored
Binary file not shown.
Before Width: | Height: | Size: 619 KiB After Width: | Height: | Size: 645 KiB |
@@ -34,41 +34,29 @@ Atom is a source code editor that's modern, approachable,
|
|||||||
yet hackable to the core—a tool you can customize to do anything but also use
|
yet hackable to the core—a tool you can customize to do anything but also use
|
||||||
productively without ever touching a config file.
|
productively without ever touching a config file.
|
||||||
|
|
||||||
.. warning::
|
|
||||||
|
|
||||||
PlatformIO IDE is **in beta testing**. Please report all issues to
|
|
||||||
`PlatformIO IDE issues tracker <https://github.com/platformio/platformio-atom-ide/issues>`_.
|
|
||||||
|
|
||||||
.. contents::
|
.. contents::
|
||||||
|
|
||||||
Requirements
|
|
||||||
------------
|
|
||||||
|
|
||||||
The only one requirement is `Python Interpreter <https://www.python.org>`_.
|
|
||||||
PlatformIO is written in Python and works on Mac OS X, Linux, Windows OS and
|
|
||||||
ARM-based credit-card sized computers (Raspberry Pi, BeagleBone, CubieBoard).
|
|
||||||
|
|
||||||
Installation
|
Installation
|
||||||
------------
|
------------
|
||||||
|
|
||||||
:Python:
|
1. Download and install Atom source code editor
|
||||||
|
|
||||||
Python is installed on Mac OS X and Linux OS by default. The only **Windows Users**
|
- `Download for Mac <https://atom.io/download/mac>`_
|
||||||
should install it manually. Please `Download the latest Python 2.7.x <https://www.python.org/downloads/>`_
|
- `Download for Windows <https://atom.io/download/windows>`_
|
||||||
and install it. **DON'T FORGET** to select ``Add python.exe to Path`` feature on the
|
- `Download .deb <https://atom.io/download/deb>`_
|
||||||
"Customize" stage, otherwise ``python`` command will not be available.
|
- `Download .rpm <https://atom.io/download/rpm>`_
|
||||||
|
- `Other platforms <https://github.com/atom/atom/releases/latest>`_
|
||||||
|
|
||||||
:Atom: Download and install `Atom <https://atom.io>`_ source code editor
|
|
||||||
|
|
||||||
:PlatformIO IDE:
|
2. Open Atom Package Manager and search for `platformio-ide <https://atom.io/packages/platformio-ide>`_
|
||||||
|
|
||||||
Install `platformio-ide <https://atom.io/packages/platformio-ide>`_ package
|
|
||||||
using:
|
|
||||||
|
|
||||||
- **Mac OS X**: ``Menu: Atom > Preferences > Install``
|
- **Mac OS X**: ``Menu: Atom > Preferences > Install``
|
||||||
- **Windows**: ``Menu: File > Settings > Install``
|
- **Windows**: ``Menu: File > Settings > Install``
|
||||||
- **Linux**: ``Menu: Edit > Preferences > Install``
|
- **Linux**: ``Menu: Edit > Preferences > Install``
|
||||||
|
|
||||||
|
.. image:: ../_static/ide-atom-platformio-install.png
|
||||||
|
|
||||||
User Guide
|
User Guide
|
||||||
----------
|
----------
|
||||||
|
|
||||||
@@ -83,8 +71,32 @@ new menu item named ``Menu: PlatformIO`` (after ``Menu: Help`` item).
|
|||||||
|
|
||||||
.. image:: ../_static/ide-atom-platformio-menu-item.png
|
.. image:: ../_static/ide-atom-platformio-menu-item.png
|
||||||
|
|
||||||
Building / Uploading / etc.
|
PlatformIO Toolbar
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
PlatformIO IDE Toolbar contains the quick access button to the popular commands.
|
||||||
|
Each button contains hint (delay mouse on it).
|
||||||
|
|
||||||
|
.. image:: ../_static/ide-atom-platformio-toolbar.png
|
||||||
|
|
||||||
|
* PlatformIO: Build
|
||||||
|
* PlatformIO: Clean
|
||||||
|
* Toggle build panel
|
||||||
|
* |
|
||||||
|
* New File
|
||||||
|
* Add/Open Project Folder...
|
||||||
|
* Find in Project...
|
||||||
|
* |
|
||||||
|
* Terminal
|
||||||
|
* Serial Ports
|
||||||
|
* Serial Monitor
|
||||||
|
* |
|
||||||
|
* Settings
|
||||||
|
* PlatformIO Documentation
|
||||||
|
|
||||||
|
Building / Uploading / Targets
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
* ``cmd-alt-b`` / ``ctrl-alt-b`` / ``f9`` builds project without auto-uploading.
|
* ``cmd-alt-b`` / ``ctrl-alt-b`` / ``f9`` builds project without auto-uploading.
|
||||||
* ``cmd-alt-u`` / ``ctrl-alt-u`` builds and uploads (if no errors).
|
* ``cmd-alt-u`` / ``ctrl-alt-u`` builds and uploads (if no errors).
|
||||||
@@ -113,39 +125,35 @@ Terminal and run ``clang --version``. If ``clang`` is not installed, then instal
|
|||||||
- **Other Systems**: Download the latest `Clang for the other systems <http://llvm.org/releases/download.html>`_.
|
- **Other Systems**: Download the latest `Clang for the other systems <http://llvm.org/releases/download.html>`_.
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
The libraries which are added, installed or used in the project
|
The libraries which are added/installed after initializing process will
|
||||||
after initializing process will not be reflected in code completion. To fix
|
not be reflected in code linter. You need ``Menu: PlatformIO >
|
||||||
it you need to reinitialize project using ``Menu: PlatformIO > Initialize new Project (or update existing)``.
|
Rebuild C/C++ Project Index (Autocomplete, Linter)``.
|
||||||
|
|
||||||
Code linter
|
Code linter
|
||||||
~~~~~~~~~~~
|
~~~~~~~~~~~
|
||||||
|
|
||||||
PlatformIO IDE uses PlatformIO's pre-built GCC toolchains for code linting. You
|
PlatformIO IDE uses PlatformIO's pre-built GCC toolchains for code linting. The
|
||||||
can customize it in ``.gcc-flags.json`` which will be generated for the selected
|
settings for Linter are located in ``.gcc-flags.json``. This file will be
|
||||||
board in the project directory using
|
automatically created and preconfigured when you initialize project using
|
||||||
``Menu: PlatformIO > Initialize new Project (or update existing)``.
|
``Menu: PlatformIO > Initialize new Project (or update existing)``.
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
The libraries which are added, installed or used in the project
|
The libraries which are added/installed after initializing process will
|
||||||
after initializing process will not be reflected in code linter. To fix
|
not be reflected in code linter. You need ``Menu: PlatformIO >
|
||||||
it you need to reinitialize project using ``Menu: PlatformIO > Initialize new Project (or update existing)``.
|
Rebuild C/C++ Project Index (Autocomplete, Linter)``.
|
||||||
|
|
||||||
|
|
||||||
|
.. error::
|
||||||
|
If you have error like ``linter-gcc: Executable not found`` and
|
||||||
|
``"***/.platformio/packages/toolchain-atmelavr/bin/avr-g++" not found``
|
||||||
|
please ``Menu: PlatformIO > Initialize new Project (or update existing)``.
|
||||||
|
|
||||||
Install Shell Commands
|
Install Shell Commands
|
||||||
~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
To install ``platformio`` and ``pio`` shell commands please use ``Menu:
|
To install ``platformio`` and ``pio`` shell commands please use ``Menu:
|
||||||
PlatformIO > Install Shell Commands``. It will allow you to call PlatformIO from
|
PlatformIO > Install Shell Commands``. It will allow you to call PlatformIO from
|
||||||
other process, terminals and etc.
|
other process, terminal and etc.
|
||||||
|
|
||||||
Serial Monitor
|
|
||||||
~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
Serial Monitor was temporary disabled in PlatformIO IDE 0.2.1. See
|
|
||||||
`issue #17 <https://github.com/platformio/platformio-atom-ide/issues/17>`_.
|
|
||||||
|
|
||||||
Temporary solution is to ``Menu: PlatformIO > Install Shell Commands`` and use
|
|
||||||
:ref:`cmd_serialports_monitor` from system Terminal application (not built-in in
|
|
||||||
PlatformIO IDE).
|
|
||||||
|
|
||||||
Known issues
|
Known issues
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~~
|
||||||
|
Reference in New Issue
Block a user