chore: update README

zeljkobekcic · Jul 9, 2024 · 000604f · 000604f
1 parent c37ecaf
commit 000604f
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -2,9 +2,12 @@
 
 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
+## How to build locally
+
+Additional requirements: `yq`, `jq`
+
+```shell
+./build.sh
+```
 
 ![Temper Keymap](keymap_img/temper.svg)
diff --git a/build.sh b/build.sh
@@ -1,5 +1,3 @@
-#!/usr/bin/env zsh
-
 ZMK_APP_PATH="$HOME/Projects/Private/zmk/app"
 ZMK_CONFIG_PATH="$HOME/Projects/Private/temper-zmk-config/config"
 ZMK_EXTRA_MODULES_PATH="$HOME/Projects/Private/temper-zmk-config"