diff --git a/docs/_static/ide-atom-platformio-menu-item.png b/docs/_static/ide-atom-platformio-menu-item.png new file mode 100644 index 00000000..88711eac Binary files /dev/null and b/docs/_static/ide-atom-platformio-menu-item.png differ diff --git a/docs/ide/atom.rst b/docs/ide/atom.rst index 9ab24d85..58a33768 100644 --- a/docs/ide/atom.rst +++ b/docs/ide/atom.rst @@ -34,6 +34,11 @@ 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 productively without ever touching a config file. +.. warning:: + + PlatformIO IDE is **in beta testing**. Please report all issues to + `PlatformIO IDE issues tracker `_. + .. contents:: Requirements @@ -43,28 +48,40 @@ The only one requirement is `Python Interpreter `_. 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). -.. attention:: - **Windows Users**: Please `Download the latest Python 2.7.x - `_ and install it. - **DON'T FORGET** to select ``Add python.exe to Path`` feature on the - "Customize" stage, otherwise ``python`` command will not be available. - Installation ------------ -1. Download and install `Atom `_ text editor -2. Install `platformio-ide `_ package - using: +:Python: - - **Mac OS X**: ``Menu: Atom > Preferences > Install`` - - **Other OS**: ``Menu: File > Settings > Install`` + Python is installed on Mac OS X and Linux OS by default. The only **Windows Users** + should install it manually. Please `Download the latest Python 2.7.x `_ + and install it. **DON'T FORGET** to select ``Add python.exe to Path`` feature on the + "Customize" stage, otherwise ``python`` command will not be available. + +:Atom: Download and install `Atom `_ source code editor + +:PlatformIO IDE: + + Install `platformio-ide `_ package + using: + + - **Mac OS X**: ``Menu: Atom > Preferences > Install`` + - **Other OS**: ``Menu: File > Settings > Install`` User Guide ---------- +.. image:: ../_static/ide-atom-platformio.png + :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio.png + +Menu item ``PlatformIO`` +~~~~~~~~~~~~~~~~~~~~~~~~ + `platformio-ide `_ package adds to Atom new menu item named ``Menu: PlatformIO`` (after ``Menu: Help`` item). +.. image:: ../_static/ide-atom-platformio-menu-item.png + Building / Uploading / etc. ~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -98,8 +115,15 @@ Terminal and run ``clang --version``. If ``clang`` is not installed, then instal reinitialize it using ``Menu: PlatformIO > Initialize new Project (or update existing)`` and specify for the which board should be activated Code completion and Linter. -Screenshot ----------- +Serial Monitor +~~~~~~~~~~~~~~ -.. image:: ../_static/ide-atom-platformio.png - :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio.png +Serial Monitor has not been implemented yet. Please take a look at +`temporary solution, issue #13 `_. + +Install Shell Commands +~~~~~~~~~~~~~~~~~~~~~~ + +To install ``platformio`` and ``pio`` shell commands please use ``Menu: +PlatformIO > Install Shell Commands``. It will allow you to call PlatformIO from +other process, terminals and etc. diff --git a/docs/installation.rst b/docs/installation.rst index 6a593987..1dfe407c 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -20,6 +20,13 @@ computers (`Raspberry Pi `_, `BeagleBone `_, `CubieBoard `_). +.. note:: + We are glad to announce official :ref:`ide_atom` which provides + comprehensive facilities for IoT development: built-in PlatformIO CLI tool, + Terminal and other instruments. + + Try :ref:`ide_atom` for free now! + .. contents:: System requirements