arne/cheapino
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add information about vial configuration

Browse Source
This commit is contained in:
Thomas Haukland
2024-04-07 22:26:53 +02:00
parent fc0937934d
commit e4a8da9a60
2 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
doc/firmware.md
View File

@@ -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):

1
readme.md
View File

@@ -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),