From 7888f214bb031780b3af02b2c5e03e194a1e70f9 Mon Sep 17 00:00:00 2001 From: Lars Alexander Blumberg Date: Mon, 26 Apr 2021 00:05:04 +0200 Subject: [PATCH] Update dependency and keyboard config instructions People who are just reading the keyboard customization instructions might overread the dependencies installations sections. Additionally, installing rustup for the first time requires sourcing cargo's env vars in case the firmware is flashed in the same shell session after installing rustup. --- README.md | 6 ++++++ doc/keyboard-layout-customization.md | 1 + 2 files changed, 7 insertions(+) diff --git a/README.md b/README.md index 408b1cd..fc54036 100644 --- a/README.md +++ b/README.md @@ -18,3 +18,9 @@ Install dependencies using the provided script: ``` ./scripts/deps.sh ``` + +The dependencies include `rustup` - if it wasn't installed on your system before and you plan to flash the firmware within the same shell session, you should additionally source the environment variables for cargo to avoid build failures: + +``` +source $HOME/.cargo/env +``` diff --git a/doc/keyboard-layout-customization.md b/doc/keyboard-layout-customization.md index faffeec..4b1936d 100644 --- a/doc/keyboard-layout-customization.md +++ b/doc/keyboard-layout-customization.md @@ -41,6 +41,7 @@ KEYMAP?=jeremy ``` ## Test build your EC +* Make sure all dependencies are installed (see above). * From the `ec` directory, run `make` to make sure it builds correctly. ## Flash your EC