Update udev rules guide

scripts/98-openocd-udev.rules

@@ -1,4 +1,9 @@
 # UDEV Rules for debug adapters/boards supported by OpenOCD
+
+#
+# INSTALLATION
+#
+
 #
 # The latest version of this file may be found at:
 # 	https://github.com/platformio/platformio-core/blob/develop/scripts/98-openocd-udev.rules
@@ -17,6 +22,11 @@
 # 	sudo udevadm control --reload-rules
 #	sudo udevadm trigger
 #
+# Ubuntu/Debian users may need to add own “username” to the “dialout” group if
+# they are not “root”, doing this issuing a
+#   sudo usermod -a -G dialout $USER
+#   sudo usermod -a -G plugdev $USER
+#
 # After this file is installed, physically unplug and reconnect your adapter/board.
 
 ACTION!="add|change", GOTO="openocd_rules_end"

scripts/99-platformio-udev.rules

@@ -12,6 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+#
+# INSTALLATION
+#
+
 # UDEV Rules for PlatformIO supported boards, http://platformio.org/boards
 #
 # The latest version of this file may be found at:
@@ -33,7 +37,8 @@
 #
 # Ubuntu/Debian users may need to add own “username” to the “dialout” group if
 # they are not “root”, doing this issuing a
-#   sudo usermod -a -G dialout yourusername
+#   sudo usermod -a -G dialout $USER
+#   sudo usermod -a -G plugdev $USER
 #
 # After this file is installed, physically unplug and reconnect your board.
 

scripts/docspregen.py

@@ -132,29 +132,29 @@ Packages
 .. warning::
     **Linux Users**:
 
-    * Ubuntu/Debian users may need to add own "username" to the "dialout"
+        * Install "udev" rules file `99-platformio-udev.rules <https://github.com/platformio/platformio-core/blob/develop/scripts/99-platformio-udev.rules>`_
-      group if they are not "root", doing this issuing a
+          (an instruction is located inside a file).
-      ``sudo usermod -a -G dialout yourusername``.
+        * Raspberry Pi users, please read this article
-    * Install "udev" rules file `99-platformio-udev.rules <https://github.com/platformio/platformio-core/blob/develop/scripts/99-platformio-udev.rules>`_
+          `Enable serial port on Raspberry Pi <https://hallard.me/enable-serial-port-on-raspberry-pi/>`__.
-      (an instruction is located in the file).
-    * Raspberry Pi users, please read this article
-      `Enable serial port on Raspberry Pi <https://hallard.me/enable-serial-port-on-raspberry-pi/>`__.
 """)
 
         if platform == "teensy":
             lines.append("""
-    **Windows Users:** Teensy programming uses only Windows built-in HID
+    **Windows Users:**
-    drivers. When Teensy is programmed to act as a USB Serial device,
+
-    Windows XP, Vista, 7 and 8 require `this serial driver
+        Teensy programming uses only Windows built-in HID
-    <http://www.pjrc.com/teensy/serial_install.exe>`_
+        drivers. When Teensy is programmed to act as a USB Serial device,
-    is needed to access the COM port your program uses. No special driver
+        Windows XP, Vista, 7 and 8 require `this serial driver
-    installation is necessary on Windows 10.
+        <http://www.pjrc.com/teensy/serial_install.exe>`_
+        is needed to access the COM port your program uses. No special driver
+        installation is necessary on Windows 10.
 """)
         else:
             lines.append("""
-    **Windows Users:** Please check that you have correctly installed USB
+    **Windows Users:**
-    driver from board manufacturer
 
+        Please check that you have a correctly installed USB driver from board
+        manufacturer
 """)
 
     return "\n".join(lines)