Skip to content

Commit

Permalink
doc: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zeljkobekcic committed Jul 13, 2024
1 parent b994811 commit 7ba0abd
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,18 @@

This is my personal ZMK config for the [temper](https://github.com/raeedcho/temper).

Some notes about this config:
- Four main layers (default, numbers/symbols, navigation, and function)
- Default layer is Colemak DHm, but there's also a QWERTY layer that can be toggled on
- Navigation layer has vim-like arrow keys
## Installing

![Temper Keymap](keymap_img/temper.svg)
1. Flash all three microcontrollers with the reset firmware which has been build. All three with the same `.uf2` firmware.
2. Flash all microcontrollers with their respective firmware
3. Turn off bluetooth, plug in the dongle and everything should be working out of the box.

## Building locally

Change the paths in the environment variables in the `.build.sh`, then run it.

```shell
./build.sh
```

This will create a directory called `output` and in there are all the `.uf2` files

0 comments on commit 7ba0abd

Please sign in to comment.