diff options
| author | ReFil <31960031+ReFil@users.noreply.github.com> | 2022-11-16 10:57:40 +0000 |
|---|---|---|
| committer | ReFil <31960031+ReFil@users.noreply.github.com> | 2022-11-18 18:09:43 +0000 |
| commit | 54abe0b531302d79cf45bf83fceab1b909fb89a0 (patch) | |
| tree | 5c8067d34bf83e51c599d215ce9c539a8cebd4a7 /README.md | |
| parent | 2562f62fdf47af240aa5abb632117cf259cdc9fa (diff) | |
Update README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 5 insertions, 7 deletions
@@ -14,18 +14,16 @@ ## To build Firmware locally using a container -### First run - Note: Either Podman or Docker is required, Podman is preferred if both are present. +If compiling on Windows use WSL2 and docker [Docker Setup Guide](https://docs.docker.com/desktop/windows/wsl/). -1. Execute `make all`. +1. Execute `make`. 2. Check the `firmware` directory for the latest firmware build. +3. Follow the programming instruction on page 8 of the [Quick Start Guide](https://kinesis-ergo.com/wp-content/uploads/Advantage360-Professional-QSG-v8-25-22.pdf) to flash the firmware. -### Subsequent runs - -If the only file you have changed is `config/adv360.keymap`, execute `make build` and check the `firmware` directory for the latest firmware build. +### Cleanup -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. +The built docker container and compiled firmware files can be deleted with `make clean`. ### Flash firmware |