diff --git a/docs/_static/python-installer-add-path.png b/docs/_static/python-installer-add-path.png new file mode 100644 index 00000000..fcb602a6 Binary files /dev/null and b/docs/_static/python-installer-add-path.png differ diff --git a/docs/ide/atom.rst b/docs/ide/atom.rst index 2a5dc3dc..971d9520 100644 --- a/docs/ide/atom.rst +++ b/docs/ide/atom.rst @@ -48,8 +48,51 @@ PlatformIO IDE is the next generation integrated development environment for IoT It's built on top of `GitHub's Atom "hackable" text editor `_. If you have already Atom installed, please install `PlatformIO IDE for Atom package `_. +.. note:: + You don't need to install PlatformIO CLI seprately to system. + PlatformIO CLI is built into PlatformIO IDE and you will be able to use it + within PlatformIO IDE Terminal. + +1. Python Interpreter +~~~~~~~~~~~~~~~~~~~~~ + +PlatformIO IDE is based on PlatformIO CLI which is written in +`Python `_. Python is installed by default +on the all popular OS except Windows. + +**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. + +.. image:: ../_static/python-installer-add-path.png + +.. _ide_atom_installation_clang: + +2. Clang for Intelligent Code Autocompletion +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +PlatformIO IDE uses `clang `_ for the Intelligent Code Autocompletion. +To check that ``clang`` is available in your system, please open +Terminal and run ``clang --version``. If ``clang`` is not installed, then install it: + +- **Mac OS X**: Install the latest Xcode along with the latest Command Line Tools + (they are installed automatically when you run ``clang`` in Terminal for the + first time, or manually by running ``xcode-select --install`` +- **Windows**: Download the latest `Clang for Windows `_. + Please select "Add LLVM to the system PATH" option on the installation step. +- **Linux**: Using package managers: ``apt-get install clang`` or ``yum install clang``. +- **Other Systems**: Download the latest `Clang for the other systems `_. + +.. warning:: + The libraries which are added/installed after initializing process will + not be reflected in code linter. You need ``Menu: PlatformIO > + Rebuild C/C++ Project Index (Autocomplete, Linter)``. + +3. IDE Installation +~~~~~~~~~~~~~~~~~~~ + Automatic Installation -~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^ Please download PlatformIO IDE for Atom bundle with built-in auto installer (be patient and let the installation complete) @@ -60,17 +103,9 @@ Please download PlatformIO IDE for Atom bundle with built-in auto installer - `Download PlatformIO IDE .rpm `_ Manual Installation -~~~~~~~~~~~~~~~~~~~ - -1. Download and install the latest Atom text editor - - - `Download Atom for Mac `_ - - `Download Atom for Windows `_ - - `Download Atom .deb `_ - - `Download Atom .rpm `_ - - `Other platforms `_ - +^^^^^^^^^^^^^^^^^^^ +1. Download and install the `latest Atom text editor `_. 2. Open Atom Package Manager and install `platformio-ide `_ Atom package - **Mac OS X**: ``Menu: Atom > Preferences > Install`` @@ -280,16 +315,8 @@ Intelligent Code Autocompletion ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ PlatformIO IDE uses `clang `_ for the Intelligent Code Autocompletion. -To check that ``clang`` is available in your system, please open -Terminal and run ``clang --version``. If ``clang`` is not installed, then install it: - -- **Mac OS X**: Install the latest Xcode along with the latest Command Line Tools - (they are installed automatically when you run ``clang`` in Terminal for the - first time, or manually by running ``xcode-select --install`` -- **Windows**: Download the latest `Clang for Windows `_. - Please select "Add LLVM to the system PATH" option on the installation step. -- **Linux**: Using package managers: ``apt-get install clang`` or ``yum install clang``. -- **Other Systems**: Download the latest `Clang for the other systems `_. +To install it or check if it exists, please follow to step +:ref:`ide_atom_installation_clang` from Installation guide. .. warning:: The libraries which are added/installed after initializing process will