README: Add description about board-specific actions.
BUG=None
TEST=None
Change-Id: I51ef3244ad5238d2a96a418e7291f4c3480e0c6f
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/factory_installer/+/1944105
Reviewed-by: Wei-Han Chen <stimim@chromium.org>
Reviewed-by: Cheng-Han Yang <chenghan@chromium.org>
Commit-Queue: Kevin Lin <kevinptt@chromium.org>
Tested-by: Kevin Lin <kevinptt@chromium.org>
Auto-Submit: Kevin Lin <kevinptt@chromium.org>
diff --git a/README.md b/README.md
index 86fb991..cadfaa5 100644
--- a/README.md
+++ b/README.md
@@ -92,6 +92,27 @@
to **<action>**. For instance, `DEFAULT_ACTION=i` sets the default action
to **(I) Install**.
+### Board-specific actions
+
+With technique
+[installer resource](https://chromium.googlesource.com/chromiumos/platform/factory/+/HEAD/resources/README.md#installer-resource)
+in factory-board, you can add some board-specific actions by defining variables
+and functions in `factory_install_board.sh` in private overlay. For example:
+
+```sh
+#!/bin/bash
+
+SUPPORTED_ACTIONS_BOARD=x
+
+menu_board() {
+ menu_line X "Magic Command" "Run magic command"
+}
+
+action_x() {
+ echo "Magic on board ${BOARD}."
+}
+```
+
## Debugging a factory shim
Factory shims do not provide shells by default for security reason. If you can
still see virtual terminal consoles, try VT0, VT1, VT2, VT3 - there are lots of
