diff --git a/docs/installation.rst b/docs/installation.rst index a6a6bc51..0dbb97e6 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -34,6 +34,12 @@ application: :ref:`MUST DISABLE ` all prompts. It will allow you to avoid blocking. +.. note:: + **Linux Users:** Don't forget to install "udev" rules file + `99-platformio-udev.rules `_ (an instruction is located in the file). + + **Windows Users:** Please check that you have correctly installed USB driver + from board manufacturer Troubleshooting --------------- @@ -67,7 +73,7 @@ script. Then run the following (you might need to run ``sudo`` first): # change directory to folder where is located downloaded "get-platformio.py" cd /path/to/dir/where/is/installer/script - + # run it python get-platformio.py @@ -78,7 +84,7 @@ On *Windows OS* it may look like: # change directory to folder where is located downloaded "get-platformio.py" cd C:\path\to\dir\where\is\installer\script - + # run it C:\Python27\python.exe get-platformio.py diff --git a/docs/platforms/atmelavr.rst b/docs/platforms/atmelavr.rst index 048b7bef..0ffb8f67 100644 --- a/docs/platforms/atmelavr.rst +++ b/docs/platforms/atmelavr.rst @@ -33,6 +33,9 @@ Packages **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). + **Windows Users:** Please check that you have correctly installed USB driver + from board manufacturer + Frameworks diff --git a/docs/platforms/atmelsam.rst b/docs/platforms/atmelsam.rst index 12b77aa8..92f515dc 100644 --- a/docs/platforms/atmelsam.rst +++ b/docs/platforms/atmelsam.rst @@ -33,6 +33,9 @@ Packages **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). + **Windows Users:** Please check that you have correctly installed USB driver + from board manufacturer + Frameworks diff --git a/docs/platforms/espressif.rst b/docs/platforms/espressif.rst index 2e159da3..1a134dcb 100644 --- a/docs/platforms/espressif.rst +++ b/docs/platforms/espressif.rst @@ -36,6 +36,9 @@ Packages **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). + **Windows Users:** Please check that you have correctly installed USB driver + from board manufacturer + Frameworks diff --git a/docs/platforms/freescalekinetis.rst b/docs/platforms/freescalekinetis.rst index 3f8bbb03..c2ebcc80 100644 --- a/docs/platforms/freescalekinetis.rst +++ b/docs/platforms/freescalekinetis.rst @@ -27,6 +27,9 @@ Packages **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). + **Windows Users:** Please check that you have correctly installed USB driver + from board manufacturer + Frameworks diff --git a/docs/platforms/nordicnrf51.rst b/docs/platforms/nordicnrf51.rst index bb922543..a4f21e32 100644 --- a/docs/platforms/nordicnrf51.rst +++ b/docs/platforms/nordicnrf51.rst @@ -27,6 +27,9 @@ Packages **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). + **Windows Users:** Please check that you have correctly installed USB driver + from board manufacturer + Frameworks diff --git a/docs/platforms/nxplpc.rst b/docs/platforms/nxplpc.rst index 1f2e402b..52edd4e5 100644 --- a/docs/platforms/nxplpc.rst +++ b/docs/platforms/nxplpc.rst @@ -27,6 +27,9 @@ Packages **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). + **Windows Users:** Please check that you have correctly installed USB driver + from board manufacturer + Frameworks diff --git a/docs/platforms/siliconlabsefm32.rst b/docs/platforms/siliconlabsefm32.rst index 448d95db..4c1b987a 100644 --- a/docs/platforms/siliconlabsefm32.rst +++ b/docs/platforms/siliconlabsefm32.rst @@ -27,6 +27,9 @@ Packages **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). + **Windows Users:** Please check that you have correctly installed USB driver + from board manufacturer + Frameworks diff --git a/docs/platforms/ststm32.rst b/docs/platforms/ststm32.rst index 1276ddbf..05cb3f18 100644 --- a/docs/platforms/ststm32.rst +++ b/docs/platforms/ststm32.rst @@ -42,6 +42,9 @@ Packages **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). + **Windows Users:** Please check that you have correctly installed USB driver + from board manufacturer + Frameworks diff --git a/docs/platforms/teensy.rst b/docs/platforms/teensy.rst index 11d25e24..29dbc2b0 100644 --- a/docs/platforms/teensy.rst +++ b/docs/platforms/teensy.rst @@ -36,6 +36,9 @@ Packages **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). + **Windows Users:** Please check that you have correctly installed USB driver + from board manufacturer + Frameworks diff --git a/docs/platforms/timsp430.rst b/docs/platforms/timsp430.rst index 913f1970..b81aada7 100644 --- a/docs/platforms/timsp430.rst +++ b/docs/platforms/timsp430.rst @@ -33,6 +33,9 @@ Packages **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). + **Windows Users:** Please check that you have correctly installed USB driver + from board manufacturer + Frameworks diff --git a/docs/platforms/titiva.rst b/docs/platforms/titiva.rst index 0f98f8d7..d54e6f33 100644 --- a/docs/platforms/titiva.rst +++ b/docs/platforms/titiva.rst @@ -36,6 +36,9 @@ Packages **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). + **Windows Users:** Please check that you have correctly installed USB driver + from board manufacturer + Frameworks diff --git a/scripts/docspregen.py b/scripts/docspregen.py index 1c07ef65..5f9f3ac5 100644 --- a/scripts/docspregen.py +++ b/scripts/docspregen.py @@ -91,6 +91,9 @@ def generate_packages(packages): **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules `_ (an instruction is located in the file). + **Windows Users:** Please check that you have correctly installed USB driver + from board manufacturer + """) return "\n".join(lines)