summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBobby Casey <bobbycasey@google.com>2022-02-13 06:49:58 +0000
committerCommit Bot <commit-bot@chromium.org>2022-02-15 19:12:39 +0000
commitdc870dfc39afeb739973a8232aef1d8c2b27dace (patch)
treebfa32209c93077b60f7bda4591c68f80ff65b8e1 /docs
parent62116801c695db22ab79ce7df98c34248d6f1fc1 (diff)
downloadchrome-ec-dc870dfc39afeb739973a8232aef1d8c2b27dace.tar.gz
docs: Set BOARD in quick build instructions
Step 3 of the instructions in the "Building" section indicate to run a make command that includes `make BOARD=${BOARD}`. This assumes that ${BOARD} is set properly but the instructions to not specify to do so. The first paragraph does link to documents that cover this but then go on to state that you can safely ignore them. Fix by adding a step to specify the BOARD env var, including a brief description of where to find this value and a safe default. BUG=b:219081299 BRANCH=none TEST=view in gitiles Signed-off-by: Bobby Casey <bobbycasey@google.com> Change-Id: I9b0a7f9b6b64ff2b1bb5844c5fa750514ecf6d1b Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3460062 Reviewed-by: Tom Hughes <tomhughes@chromium.org>
Diffstat (limited to 'docs')
-rw-r--r--docs/getting_started_quickly.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/getting_started_quickly.md b/docs/getting_started_quickly.md
index 325bef39b0..f9808c76da 100644
--- a/docs/getting_started_quickly.md
+++ b/docs/getting_started_quickly.md
@@ -28,6 +28,19 @@ toolchain incompatibilities may require extra debug.
git clone https://chromium.googlesource.com/chromiumos/platform/ec
```
+1. Select a target board
+
+ ```bash
+ export BOARD=<target board>
+ ```
+
+ Refer to the [Chromium OS Developer
+ Guide](https://chromium.googlesource.com/chromiumos/docs/+/HEAD/developer_guide.md)
+ for more details about selecting the appropriate target board. If you are
+ just getting your environment set up and are unsure which board you will be
+ targeting then you may select a board from `board/` or just
+ choose a safe default, such as `nocturne`.
+
1. Build your EC image:
```bash