update readme

juliamertz · Nov 4, 2024 · db8de45 · db8de45
1 parent d50ef27
commit db8de45
Showing 1 changed file with 7 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -2,15 +2,18 @@
 
 ## Build firmware
 
-```sh
-# This will output the firmware file to `/result/glove80.uf2`
-nix build 
-```
+Executing `nix build` will output the firmware file to `/result/glove80.uf2`
 
 ## Flash firmware
 
 First execute `nix run`, then connect both halves and put them into bootloader mode.
 
+## Other
+
+To format `.keymap` files in the repository run `nix run .#format .`
+
+Running `nix build .#visual` generates a visualization of the keymap and writes it to `/result/layout.svg`
+
 ## Layout
 
 ![SVG of keyboard layout](assets/layout.svg)