summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJosh French <josh.french@rstudio.com>2022-10-11 11:24:22 -0400
committerJosh French <josh.french@rstudio.com>2022-10-11 11:24:22 -0400
commitb3e58a53b89c014f61c0afbcb72c37ed5f89771e (patch)
tree9b3f3a7d3815bcaef6c66d3bab12819e774cef84 /README.md
parent1d14ffdb3007ee906a59e0392d4ae78f797d8e77 (diff)
Update docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/README.md b/README.md
index 4a916f8..c2878b5 100644
--- a/README.md
+++ b/README.md
@@ -14,14 +14,16 @@
## To build Firmware locally using Docker
-### Setup
+### First run
-1. Execute `setup.sh`.
+1. Execute `make all`.
+2. Check the `firmware` directory for the latest firmware build.
-### Build firmware
+### Subsequent runs
-1. Execute `run.sh`
-2. Check the `firmware` directory for the latest firmware build.
+If the only file you have changed is `config/adv360.keymap`, execute `make build` and check the `firmware` directory for the latest firmware build.
+
+If you have changed other files in the `config` directory (such as `config/west.yml`) you will need to execute `make all` to rebuild the Docker image as well as the firmware.
### Flash firmware