~craftyguy/Adv360-Pro-ZMK

603133f0600e747e083ffc92ee3dd9a4fcf7e8d0 — Tom Plunket 1 year, 3 months ago 1a5041d
Provide flashing instructions, point at GUI editor, and format support links.
1 files changed, 29 insertions(+), 10 deletions(-)

M README.md
M README.md => README.md +29 -10
@@ 1,6 1,10 @@
# ADV360-PRO-ZMK

## To build Firmware in GitHub Actions
## Modifying the keymap

There is a GUI for editing the keymap. It is available at https://kinesiscorporation.github.io/Adv360-Pro-GUI

## Building the Firmware with GitHub Actions

### Setup



@@ 12,19 16,20 @@
1. Push a commit to trigger the build.
2. Download the artifact.

## Local building in a container
## Building the Firmware in a local container

### Setup

#### Software

Either Podman or Docker is required, Podman is preferred if both are present.\
Make is also required
* 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`).

* 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



@@ 39,8 44,22 @@ The built docker container and compiled firmware files can be deleted with `make

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.

### briefly

1. Extract the firmwares from the downloaded archive.
1. Connect the keyboards via USB.
1. Mod+macro1 to put the left side into bootloader mode; it should attach to your computer as a USB drive. (There's also a physical button between the Delete/Home/End keys.)
1. Copy `left.uf2` to the USB drive and it will disconnect.
1. Power off both keyboards (by unplugging them and making sure the switch is off).
1. Restart the left then the right keyboard.
1. Mod+macro3 to put the right side into bootloader mode. (There's also a physical button between the Enter/PgUp/PgDn keys.)
1. Copy `right.uf2` to the mounted drive.
1. Keyboard may need to be power cycled again.
1. Enjoy!

## 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/#manuals
Further support resources can be found on Kinesis.com:

* https://kinesis-ergo.com/support/kb360pro/#firmware-updates
* https://kinesis-ergo.com/support/kb360pro/#manuals