Skip to content

Latest commit

 

History

History
 
 

quickstart

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

Miryoku ZMK Quickstart Guide https://raw.githubusercontent.com/manna-harbour/miryoku/master/data/logos/miryoku-roa-32.png

A personalised build of Miryoku ZMK can be set up, built, downloaded, and flashed onto your keyboard in a few minutes without installing any software or editing any files.

Initial Setup

  • Press the I understand my workflows, go ahead and enable them button.

Build

Start here to build new firmware after completing the initial setup.

  • Press the Fetch and merge button in the popup if it is enabled.

  • Select the Actions tab.

  • Select Build Inputs from the Workflows list on the left.
  • Press the Run workflow button on the right.

  • Fill out the fields in the popup as desired. See the Options documentation for details.

  • Press the Run workflow button at the bottom of the popup.

  • Wait for the workflow run to complete.

Download

Start here to download previously built firmware.

  • Select the workflow run from the list.

  • Select the artifact at the bottom.

  • Wait for the download to complete.
  • Unzip the downloaded zip file.

Flash

Start here to flash previously downloaded firmware.

The downloaded zip will contain a uf2 firmware file. For split keyboards the zip will contain separate firmware files for the left and right sides, and the following steps should be performed for each side.

  • Connect the keyboard to the computer with a USB cable.
  • Double tap the reset button rapidly (two presses within half a second). The keyboard will appear to the computer as a USB mass storage device.
  • Copy the firmware file to the device. The keyboard will reset and the device will be removed.

https://raw.githubusercontent.com/manna-harbour/miryoku/master/data/logos/manna-harbour-boa-32.png