Readme Cleanup
This commit is contained in:
@@ -12,21 +12,35 @@
|
|||||||
1. Push a commit to trigger the build.
|
1. Push a commit to trigger the build.
|
||||||
2. Download the artifact.
|
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.
|
### Setup
|
||||||
If compiling on Windows use WSL2 and docker [Docker Setup Guide](https://docs.docker.com/desktop/windows/wsl/).
|
|
||||||
|
#### 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`.
|
1. Execute `make`.
|
||||||
2. Check the `firmware` directory for the latest firmware build.
|
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
|
### Cleanup
|
||||||
|
|
||||||
The built docker container and compiled firmware files can be deleted with `make clean`.
|
The built docker container and compiled firmware files can be deleted with `make clean`.
|
||||||
|
|
||||||
### Flash firmware
|
## Flashing firmware
|
||||||
|
|
||||||
Resources can be found on Kinesis.com
|
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
|
||||||
|
|
||||||
|
Further support resources can be found on Kinesis.com
|
||||||
https://kinesis-ergo.com/support/kb360pro/#firmware-updates
|
https://kinesis-ergo.com/support/kb360pro/#firmware-updates
|
||||||
https://kinesis-ergo.com/support/kb360pro/#manuals
|
https://kinesis-ergo.com/support/kb360pro/#manuals
|
||||||
|
|||||||
Reference in New Issue
Block a user