Skip to content

Commit

Permalink
Clarify readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xudongzheng committed Aug 29, 2023
1 parent 7dfd6c9 commit 2c3c8c9
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ options for customization.
If you have questions, feel free to join the [SliceMK
Discord](https://discord.gg/FQvyd7BAaA).

# Instructions
# Getting Started

- Fork this repository on GitHub.
- Modify the `board` and `shield` values in `build.yaml` to match the ZMK build
Expand All @@ -17,8 +17,8 @@ Discord](https://discord.gg/FQvyd7BAaA).

- To modify your keymap, edit `config/slicemk_ergodox.keymap`.
- If you are using a dongle, add custom ZMK configuration options to
`config/slicemk_ergodox_dongle.conf`. If you are not using a dongle, that
should go in `config/slicemk_ergodox_leftcentral.conf`.
`config/slicemk_ergodox_dongle.conf`. If you are not using a dongle, custom
options should instead go in `config/slicemk_ergodox_leftcentral.conf`.
- To use with a custom ZMK fork, edit `config/west.yml`.

# Board/Shield
Expand All @@ -27,6 +27,10 @@ If you are not sure which dongle or PCB version you have, please put your
dongle/PCB into bootloader mode and check the "Model" value within the
`INFO_UF2.TXT` file.

GitHub Actions will only build the firmware for your central. Please download
the firmware for your peripheral(s)
[here](https://www.slicemk.com/pages/ergodox-wireless-peripheral).

Here are some of the common dongle options:

- **Raytac MDBT50Q-RX Green**
Expand Down

0 comments on commit 2c3c8c9

Please sign in to comment.