Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
yumagulovrn authored Jun 17, 2023
1 parent 5ae1f57 commit 8efc6f6
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 46 deletions.
53 changes: 47 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,63 @@
# ZMK Firmware for Dao keyboard

This is a repository for a ZMK Firmware for both Dao42 and Dao44 keyboards.

* [main](https://github.com/yumagulovrn/dao-zmk-config/tree/main) branch is for Dao42
* [dao44](https://github.com/yumagulovrn/dao-zmk-config/tree/dao44) branch is, obviously, for Dao44

## Default keymap

### Dao42

Visual representation of the default keymap in keyboard-layout-editor: [KLE](http://www.keyboard-layout-editor.com/#/gists/67a81f6b83c65abcda5e7f32989a1688)

This layout is heavily inspired by [this](https://github.com/aroum/Watchman-layouts)

### Dao44

Visual representation of the default keymap in keyboard-layout-editor: [KLE](http://www.keyboard-layout-editor.com/#/gists/c6ba0634e5b92366be9f324775394e66)

This layout is heavily inspired by [this](https://github.com/KGOH/Jian-Info)

### Dao42
Because of current ZMK limitations, Dao44 keymap is in the branch [dao44](https://github.com/yumagulovrn/dao-zmk-config/tree/dao44)

Visual representation of the default keymap in keyboard-layout-editor: [KLE](http://www.keyboard-layout-editor.com/#/gists/67a81f6b83c65abcda5e7f32989a1688)
## FAQ

Because of current ZMK limitations, Dao42 keymap is in the branch [dao42](https://github.com/yumagulovrn/dao-zmk-config/tree/dao42)
- [FAQ](#faq)
- [How to change the keymap?](#how-to-change-the-keymap)
- [How to flash the keyboard?](#how-to-flash-the-keyboard)
- [How to pair halves?](#how-to-pair-halves)
- [Problems](#problems)
- [I'm getting File Transfer Error after copying firmware to the keyboard](#im-getting-file-transfer-error-after-copying-firmware-to-the-keyboard)

This layout is heavily inspired by [this](https://github.com/aroum/Watchman-layouts)
### How to change the keymap?

1. Fork the repository https://github.com/yumagulovrn/dao-zmk-config
2. Make changes to the [dao.keymap](../config/boards/arm/dao/dao.keymap) file in your repository
3. Commit changes to your repository
4. Go to `Actions` tab in your repository
5. Wait for the GitHub Action to complete
6. Grab `firmware.zip` file - it contains firmware for both of your halves

### How to flash the keyboard?

1. Obtain `firmware.zip`
2. Unzip `firmware.zip` - you should have `dao_left.uf2` and `dao_right.uf2` files
3. Turn off the power for selected halve (move slider to position `OFF`)
4. Connect selected halve to the PC via USB-C cable
5. Press `RESET` button **twice** to enter DFU mode - you should see new USB device in your file manager
6. Copy the corresponding firmware to the root directory of the new USB device
7. Disconnect selected halve from the PC
8. Repeat steps 3-7 for the other halve

### How to pair halves?

1. Turn off the power for both halves (move slider to position `OFF`)
2. Turn on the power for both halves (move slider to position `ON`)
3. Press `RESET` button **once** on both halves **simultaneously**

### Problems

## Documentation
#### I'm getting File Transfer Error after copying firmware to the keyboard

Answers to frequently asked questions can be found in [FAQ](docs/FAQ.md)
It's OK. Proof: https://zmk.dev/docs/troubleshooting#file-transfer-error
40 changes: 0 additions & 40 deletions docs/FAQ.md

This file was deleted.

0 comments on commit 8efc6f6

Please sign in to comment.