Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sky-bro committed Sep 8, 2024
1 parent e5aa785 commit 658a539
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 8 deletions.
14 changes: 10 additions & 4 deletions README-zh_CN.org
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,21 @@

* 快速上手

** 刷入固件
** 固件刷入

1. [[https://github.com/sky-bro/zmk-config/fork][fork]]这个仓库
2. (可选) 更新keymap或者config文件
3. 等待github action编译固件, 然后下载解压固件
4. usb连接你想刷入固件的左手或右手到电脑
5. 通过蓝牙或usb连接键盘连接到一个设备
6. 左手或右手按 =&bootloader= 进入刷机模式
7. 复制固件到相应手 (更新键位或者键盘名不需要刷右手)
5. 左手或右手进入bootloader, 进入bootloader方法任选下面一种即可
1) 按键盘上的 =&bootloader= 键 (要求已通过蓝牙或usb连接键盘连接到一个设备)
2) 双击reset
3) 快速短接两次reset
4) 快速短接两次主控上的gnd和rst脚(左上角第二三两个排针)
6. 复制固件到相应手 (更新键位或者键盘名不需要刷右手)
1) 左手刷left文件
2) 右手刷right文件
3) 想要清空左手或右手的蓝牙连接信息刷reset文件(一般左右手连不上的时候刷)

** 键位说明

Expand Down
14 changes: 10 additions & 4 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,16 @@
1. [[https://github.com/sky-bro/zmk-config/fork][fork]] this repo
2. (optional) update keymap and config file
3. wait github action to build the firmware, then you download and decompress the zip file
4. connect left or right half of keyboard you want to flash to your computer with use cable
5. connect keyboard to a device with either usb or bluetooth.
6. left or right half enter bootloader with =&bootloader= key
7. copy firmware to your half of keyboard (updating keymap and changing keyboard name do not have to flash the right half)
4. connect left or right half to your computer with use cable
5. left or right half enter bootloader, you can enter bootloader by
1) pressing the =&bootloader= key (requires that keyboard is connected to a device for typing)
2) double-clicking the reset button
3) quickly short-circuiting the reset button twice (if the button is not working)
4) quickly short-circuiting the gnd & rst pins of the controller twice (top left corner, the second & thrid pins)
6. copy firmware to your half of keyboard (updating keymap and changing keyboard name do not have to flash the right half)
1) filename with 'left' is for the left half of keyboard
2) filename with 'right' is for the right half of keyboard
3) filename with 'reset' is for the left/right half to forget its bluetooth connection info (when left & right half is not able to connect, to forget paired devices)

** My Keymap

Expand Down

0 comments on commit 658a539

Please sign in to comment.