Skip to content

Commit

Permalink
Merge pull request KinesisCorporation#57 from KinesisCorporation/56-i…
Browse files Browse the repository at this point in the history
…nstructions-in-readme-fail

Update README.md to account for new makefile setup
  • Loading branch information
ReFil authored Nov 21, 2022
2 parents 685f436 + 49fb545 commit 0fb8e58
Showing 1 changed file with 21 additions and 9 deletions.
30 changes: 21 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 0fb8e58

Please sign in to comment.