diff --git a/doc/firmware.md b/doc/firmware.md index fa872b1..2722741 100644 --- a/doc/firmware.md +++ b/doc/firmware.md @@ -1,6 +1,21 @@ +Configuring using vial +====================== + +This is the easiest way of setting up your keyboard: + +1. Download cheapino_vial.uf2 file for your release(1 or 2) +2. Put your rp2040-zero in dfu mode by holding boot button while you plug in usb c +3. Drag and drop uf2 file to the usb drive that popped up after 2. +4. Download vial from here: https://get.vial.today/download/ +5. Open it and start customizing + +For now, you will not be able to customize encoder with this.(working on it...) + Setting up and compiling qmk ============================ +For most flexibility, you want to compile the qmk firmware yourself. + Unfortunately, the cheapino firmware is not merged into the official qmk repository, so there are a few extra steps to setting up qmk for compiling cheapino. This is the recipe for windows(for mac/linux, install qmk the recommended way and jump to step 3): diff --git a/readme.md b/readme.md index 16d339c..3c447a5 100644 --- a/readme.md +++ b/readme.md @@ -20,6 +20,7 @@ Checkout the [build guide](doc/buildguide_v1.md) for more details and pictures. Checkout the [troubleshooting guide](doc/troubleshooting.md) if your Cheapino does not work. See the [firmware guide](doc/firmware.md) for how to build and customize keyboard firmware. +News: both v1 and v2 supports vial, checkout the cheapino_vial.uf2 in the releases. If you just want to flash [Miryoku](https://github.com/manna-harbour/miryoku) on your Cheapino, download the [uf2 file from the release section](https://github.com/tompi/cheapino/releases/download/v1.0/cheapino_manna-harbour_miryoku.uf2),