Merge pull request #3978 from tock/getting-started-2024-may

doc: Getting Started updates
tock · May 8, 2024 · ba427f3 · ba427f3
2 parents 7b494ee + f1bfc10
commit ba427f3
Show file tree

Hide file tree

Showing 3 changed files with 165 additions and 171 deletions.
diff --git a/boards/nucleo_f429zi/README.md b/boards/nucleo_f429zi/README.md
@@ -56,3 +56,19 @@ $ make program
 ```
 
 to flash the image.
+
+### (Linux): Adding a `udev` rule
+
+You may want to add a `udev` rule in `/etc/udev/rules.d` that allows you to
+interact with the board as a user instead of as root. You can install this as
+`/etc/udev/rules.d/99-stlinkv2-1.rules`:
+
+```
+# stm32 nucleo boards, with onboard st/linkv2-1
+# ie, STM32F0, STM32F4.
+# STM32VL has st/linkv1, which is quite different
+
+SUBSYSTEMS=="usb", ATTRS{idVendor}=="0483", ATTRS{idProduct}=="374b", \
+    MODE:="0660", GROUP="dialout", \
+    SYMLINK+="stlinkv2-1_%n"
+```
diff --git a/boards/nucleo_f446re/README.md b/boards/nucleo_f446re/README.md
@@ -56,3 +56,19 @@ $ make program
 ```
 
 to flash the image.
+
+### (Linux): Adding a `udev` rule
+
+You may want to add a `udev` rule in `/etc/udev/rules.d` that allows you to
+interact with the board as a user instead of as root. You can install this as
+`/etc/udev/rules.d/99-stlinkv2-1.rules`:
+
+```
+# stm32 nucleo boards, with onboard st/linkv2-1
+# ie, STM32F0, STM32F4.
+# STM32VL has st/linkv1, which is quite different
+
+SUBSYSTEMS=="usb", ATTRS{idVendor}=="0483", ATTRS{idProduct}=="374b", \
+    MODE:="0660", GROUP="dialout", \
+    SYMLINK+="stlinkv2-1_%n"
+```