From 54abe0b531302d79cf45bf83fceab1b909fb89a0 Mon Sep 17 00:00:00 2001 From: ReFil <31960031+ReFil@users.noreply.github.com> Date: Wed, 16 Nov 2022 10:57:40 +0000 Subject: [PATCH 1/2] Update README.md --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 258694ef11..4265e2d766 100644 --- a/README.md +++ b/README.md @@ -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 From 49fb5453108900e7cf5cc20ee7d65a08d1d58995 Mon Sep 17 00:00:00 2001 From: ReFil <31960031+ReFil@users.noreply.github.com> Date: Fri, 18 Nov 2022 22:31:12 +0000 Subject: [PATCH 2/2] Readme Cleanup --- README.md | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4265e2d766..f284f9e87c 100644 --- a/README.md +++ b/README.md @@ -12,21 +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 -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/). +### Setup + +#### Software + +Either Podman or Docker is required, Podman is preferred if both are present.\ +Make is also required + +#### 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`). + +### Build firmware 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. ### Cleanup The built docker container and compiled firmware files can be deleted with `make clean`. -### Flash firmware +## Flashing 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. + +## 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