diff options
| author | ReFil <31960031+ReFil@users.noreply.github.com> | 2022-11-21 12:35:39 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-21 12:35:39 +0000 |
| commit | 0fb8e5824fee2fb11f263de745f5b1c0efbcd78a (patch) | |
| tree | 83b08030c3849ab1ca81d8c3c60625577b85b053 | |
| parent | 685f4364313a0dec192438a330d47be53e8432b9 (diff) | |
| parent | 49fb5453108900e7cf5cc20ee7d65a08d1d58995 (diff) | |
Merge pull request #57 from KinesisCorporation/56-instructions-in-readme-fail
Update README.md to account for new makefile setup
| -rw-r--r-- | README.md | 30 |
1 files changed, 21 insertions, 9 deletions
@@ -12,23 +12,35 @@ 1. Push a commit to trigger the build. 2. Download the artifact. -## To build Firmware locally using a container +## Local building in a container -### First run +### Setup + +#### Software + +Either Podman or Docker is required, Podman is preferred if both are present.\ +Make is also required -Note: Either Podman or Docker is required, Podman is preferred if both are present. +#### Windows specific +If compiling on Windows use WSL2 and Docker [Docker Setup Guide](https://docs.docker.com/desktop/windows/wsl/).\ +Install make using `sudo apt-get install make`.\ +The repository can be cloned directly into the WSL2 instance or accessed through the C: mount point WSL provides by default (`/mnt/c/path-to-repo`). -1. Execute `make all`. +### Build firmware + +1. Execute `make`. 2. Check the `firmware` directory for the latest firmware build. -### Subsequent runs +### Cleanup + +The built docker container and compiled firmware files can be deleted with `make clean`. -If the only file you have changed is `config/adv360.keymap`, execute `make build` and check the `firmware` directory for the latest firmware build. +## Flashing firmware -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. +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. -### Flash firmware +## Other support -Resources can be found on Kinesis.com +Further support resources can be found on Kinesis.com https://kinesis-ergo.com/support/kb360pro/#firmware-updates https://kinesis-ergo.com/support/kb360pro/#manuals |