From bf15ba3a786d0926723e743e8cca36d48ac82819 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Fri, 21 Aug 2015 23:41:50 +0300 Subject: [PATCH] =?UTF-8?q?Add=20answer=20to=20FAQ=20when=20Program=20?= =?UTF-8?q?=E2=80=9Cplatformio=E2=80=9D=20not=20found=20in=20PATH=20//=20R?= =?UTF-8?q?esolve=20#272?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- HISTORY.rst | 2 ++ docs/faq.rst | 22 ++++++++++++++++++++++ docs/ide/atom.rst | 5 +++++ docs/ide/clion.rst | 5 +++++ docs/ide/eclipse.rst | 5 +++++ docs/ide/qtcreator.rst | 5 +++++ docs/ide/sublimetext.rst | 5 +++++ docs/ide/vim.rst | 5 +++++ docs/ide/visualstudio.rst | 5 +++++ 9 files changed, 59 insertions(+) diff --git a/HISTORY.rst b/HISTORY.rst index 3d03dc5c..0c7e75de 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -19,6 +19,8 @@ Release History * Updated ``tool-teensy`` for `Teensy `__ platform (`issue #268 `_) +* Added answer to FAQ when `Program "platformio" not found in PATH `_ + (`issue #272 `_) * Fixed includes list for Windows OS when generating project for `Eclipse IDE `__ (`issue #270 `_) * Fixed ``AttributeError: 'module' object has no attribute 'packages'`` diff --git a/docs/faq.rst b/docs/faq.rst index 62bf6d5b..f1a63ee4 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -75,6 +75,28 @@ There are a few options: - masking under Continuous Integration system via environment variable :envvar:`CI=true `. +.. _faq_troubleshooting_pionotfoundinpath: + +Program ``platformio`` not found in PATH +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Where is ``platformio`` binary installed? Run this command in Terminal + +.. code-block:: bash + + # for Unix + which platformio + echo $PATH + + # for Windows OS + where platformio + echo %PATH% + +For example, ``which platformio`` is equal to ``/usr/local/bin/platformio``, +then `PATH (wiki) `_ +should contain ``/usr/local/bin`` directory. + +Answered in `issue #272 `_. Windows: ``UnicodeDecodeError: 'ascii' codec can't decode byte`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/ide/atom.rst b/docs/ide/atom.rst index c4fa674c..9b95c621 100644 --- a/docs/ide/atom.rst +++ b/docs/ide/atom.rst @@ -20,6 +20,11 @@ page for more detailed information. Integration ----------- +.. note:: + Please verify that folder where is located ``platformio`` program is added + to `PATH (wiki) `_ environment + variable. See FAQ: :ref:`faq_troubleshooting_pionotfoundinpath`. + Using `Atom Packages `_ please install `platomformio `_ package. diff --git a/docs/ide/clion.rst b/docs/ide/clion.rst index 4f8bc333..34eb1be7 100644 --- a/docs/ide/clion.rst +++ b/docs/ide/clion.rst @@ -22,6 +22,11 @@ page for more detailed information. Integration ----------- +.. note:: + Please verify that folder where is located ``platformio`` program is added + to `PATH (wiki) `_ environment + variable. See FAQ: :ref:`faq_troubleshooting_pionotfoundinpath`. + Project Generator ^^^^^^^^^^^^^^^^^ diff --git a/docs/ide/eclipse.rst b/docs/ide/eclipse.rst index e40fcbff..9a357e39 100644 --- a/docs/ide/eclipse.rst +++ b/docs/ide/eclipse.rst @@ -26,6 +26,11 @@ page for more detailed information. Integration ----------- +.. note:: + Please verify that folder where is located ``platformio`` program is added + to `PATH (wiki) `_ environment + variable. See FAQ: :ref:`faq_troubleshooting_pionotfoundinpath`. + Project Generator ^^^^^^^^^^^^^^^^^ diff --git a/docs/ide/qtcreator.rst b/docs/ide/qtcreator.rst index e53ff505..2708b1b5 100644 --- a/docs/ide/qtcreator.rst +++ b/docs/ide/qtcreator.rst @@ -18,6 +18,11 @@ page for more detailed information. Integration ----------- +.. note:: + Please verify that folder where is located ``platformio`` program is added + to `PATH (wiki) `_ environment + variable. See FAQ: :ref:`faq_troubleshooting_pionotfoundinpath`. + Project Generator ^^^^^^^^^^^^^^^^^ diff --git a/docs/ide/sublimetext.rst b/docs/ide/sublimetext.rst index 9e6ab34e..c060c92a 100644 --- a/docs/ide/sublimetext.rst +++ b/docs/ide/sublimetext.rst @@ -18,6 +18,11 @@ page for more detailed information. Integration ----------- +.. note:: + Please verify that folder where is located ``platformio`` program is added + to `PATH (wiki) `_ environment + variable. See FAQ: :ref:`faq_troubleshooting_pionotfoundinpath`. + Project Generator ^^^^^^^^^^^^^^^^^ diff --git a/docs/ide/vim.rst b/docs/ide/vim.rst index a9ccc115..76f87ced 100644 --- a/docs/ide/vim.rst +++ b/docs/ide/vim.rst @@ -15,6 +15,11 @@ This software can be used with: Integration ----------- +.. note:: + Please verify that folder where is located ``platformio`` program is added + to `PATH (wiki) `_ environment + variable. See FAQ: :ref:`faq_troubleshooting_pionotfoundinpath`. + Recommended bundles: * Syntax highlight - `Arduino-syntax-file `_ diff --git a/docs/ide/visualstudio.rst b/docs/ide/visualstudio.rst index ef365e78..5780839d 100644 --- a/docs/ide/visualstudio.rst +++ b/docs/ide/visualstudio.rst @@ -18,6 +18,11 @@ page for more detailed information. Integration ----------- +.. note:: + Please verify that folder where is located ``platformio`` program is added + to `PATH (wiki) `_ environment + variable. See FAQ: :ref:`faq_troubleshooting_pionotfoundinpath`. + Project Generator ^^^^^^^^^^^^^^^^^