clean up + new readme

.github/workflows/check.yaml

@@ -22,5 +22,4 @@ jobs:
       - name: Run flake checker
         uses: DeterminateSystems/flake-checker-action@main
       - name: Check flake
-        # TODO print to $GITHUB_STEP_SUMMARY
         run: nix flake check

README.md

@@ -1,182 +1,24 @@
-# My ZMK config for the MoErgo Glove80
+Based on [Matt Sturgeon's config](https://github.com/MattSturgeon/glove80-config)
 
-![Photo](img/glove80_photo.png)
+# Usage
 
-Based on [MoErgo's template](https://github.com/moergo-sc/glove80-zmk-config) and [Gaétan Lepage's flake](https://github.com/GaetanLepage/glove80-zmk-config).
+## Build firmware
 
-This repo contains the current config for my Glove80 keyboard.
-The keymap was initially built using MoErgo's [Layout Editor](https://my.glove80.com),
-however it is now maintained using [Keymap Editor] with occasional manual tweaking.
+```sh
+nix build
+```
 
-The keyboard firmware can be built locally using `nix`, which is also used for [automatic builds].
+This will output the firmware file to `/result/glove80.uf2`
 
-[Keymap Drawer] is used to render images of each layer (see below).
+## Flash firmware
+TODO: flash both halves with one script
+```sh
+# Connect the right half (in bootloader mode)
+Run nix run
+# Connect the left half (in bootloader mode)
+Run nix run
+```
 
-## Layers
-
-### Base Layers
-
-The default base layer uses Colemak DH. Some punctuation is moved around using Mod Morphs, and useful stuff is placed on the thumb keys.
-
-![Default](img/glove80_default.svg)
-
-There is a secondary Qwerty base layer available as a fallback:
-
-![Qwerty](img/glove80_qwerty.svg)
-
-### Gaming
-
-A gaming layer extends Qwerty, shifting WASD to a more comfortable position.
-
-![Gaming](img/glove80_gaming.svg)
-
-### Symbols
-
-Readily accessible from a thumb key, the symbols layer attempts to find comfortable positions for commonly used programming symbols.
-
-![Symbols](img/glove80_symbols.svg)
-
-### Numbers & Navigation
-
-Also on the thumb keys, a nav layer has a comfortable numpad and navigation keys.
-
-![Numbers & Navigation](img/glove80_navigation.svg)
-
-I may consider switching from a numpad layout to a 2x 4-finger numrow in an attempt to keep everything closer to the home row. Alternatively, moving the `0` key up may have the same effect.
-
-### MoErgo's Magic Layer
-
-As standard on all Glove80 keyboards, a Magic layer provider access to system utilities, such as Bluetooth settings and RGB lighting config.
-
-![Magic Layer](img/glove80_magic.svg)
-
-## Setup
-
-### Flashing Firmware
-
-Before flashing, ensure `udisks2` is setup and enabled so that the keyboard can mount its bootloader storage device.
-
-- [`services.udisks2.enable`](https://nixos.org/manual/nixos/stable/options#opt-services.udisks2.enable) NixOS option
-- `systemctl status udisks2.service`
-- `udisksctl status`
-
-#### Flashing automatically
-
-The easiest way to flash the firmware is using `nix run`.
-
-- `cd` into the project root
-- Connect the **right** half (in bootloader mode)
-- Run `nix run`
-- Connect the **left** half (in bootloader mode)
-- Run `nix run`
-- Done!
-
-#### Flashing manually
-
-You can also manually copy the `uf2` firmware file to the keyboard.
-
-The firmware can be built locally using `nix build` and will be written to `./result/glove80.uf2`.
-Alternatively, the firmware can be downloaded from [GitHub Actions][automatic builds]'s artifacts.
-
-Connect the keyboard half in bootloader mode, then copy the firmware file into the keyboard's USB storage.
-The keyboard will unmount when it has finished flashing.
-
-### Booting into bootloader mode
-
-See the [user guide](https://docs.moergo.com/glove80-user-guide/customizing-key-layout/#putting-glove80-into-bootloader-for-firmware-loading) for more info.
-
-- Hold the `C6 R6` key (extreme bottom corner)
-- Also hold the `C3 R2` key (middle-finger; Colemak `F` or `U`, Qwerty `E` or `I`)
-- Power on the keyboard
-
-![Activating bootloader](https://docs.moergo.com/glove80-user-guide/images/bootloader-power-up-method.png)
-
-#### You can tell if a Glove80 half is in bootloader mode using the red LED next to the power switch:
-
-- Slow LED: in bootloader mode and connected via USB.
-- Fast LED: in bootloader mode but there is no USB connection.
-- Solid or no LED: not in bootloader mode.
-
-### Factory reset
-
-See the [user guide](https://docs.moergo.com/glove80-user-guide/troubleshooting/#configuration-factory-reset-and-re-pairing-left-and-right-halves) for more info.
-
-Similar to booting into bootloader mode, but use `R2` (numrow) instead of `R3`. Hold for ~5s powered on, before powering off again.
-
-![Activating reset](https://docs.moergo.com/glove80-user-guide/images/configuration-factory-reset.png)
-
-Note, the reset will not affect the saved keymap. Instead it wipes things like Bluetooth devices.
-
-To re-pair the two halves: first power both on at the same time, then toggle RGB on/off with (Colemak) `Magic`+`B` or (Qwerty) `Magic`+`T`.
-
-### Bluetooth
-
-See the [user guide](https://docs.moergo.com/glove80-user-guide/operating-glove80-wirelessly) for more info.
-
-#### Status
-
-When tapping the `Magic` key, status indicators will appear on the Bluetooth keys.
-
-<!-- Catppuccin themed "LED indicator" bullet points 😅 -->
-<p>
-  <img alt="White LED"
-    title="White LED"
-    height="11"
-    hspace="4"
-    src="https://github.com/MattSturgeon/glove80-config/assets/5046562/46cf34a5-efa4-4b6c-a9d5-703b4d4c32bd">
-  <strong>Connected</strong> (in use)
-  <br>
-  <img alt="Green LED"
-    title="Green LED"
-    height="11"
-    hspace="4"
-    src="https://github.com/MattSturgeon/glove80-config/assets/5046562/41369794-bf61-4873-b7fc-4949868a322e">
-  <strong>Connected</strong> (not in use)
-  <br>
-  <img alt="Red LED"
-    title="Red LED"
-    height="11"
-    hspace="4"
-    src="https://github.com/MattSturgeon/glove80-config/assets/5046562/da7e6899-9833-4c82-a856-947f8f429d1a">
-  <strong>Paired</strong> (not connected)
-  <br>
-  <img alt="Purple LED"
-    title="Purple LED"
-    height="11"
-    hspace="4"
-    src="https://github.com/MattSturgeon/glove80-config/assets/5046562/0579c055-75ff-4ddd-9a99-a7fadd3df992">
-  <strong>Not paired</strong>
-</p>
-
-
-#### Pairing
-
-- First ensure the profile is unpaired (white status LED)
-- Select the profile
-- Pair using the host device's interface
-
-#### Unpairing
-
-Unpair the selected Bluetooth profile using the `BT_Clear` key (see [magic layer] above). Alternatively unpair all devices using `BT_Clear_All`.
-
-
-## Resources
-- [@nickcoutsos]'s [Keymap Editor] ([webapp](https://nickcoutsos.github.io/keymap-editor)).
-- [@caksoylar]'s [Keymap Drawer].
-
-- [Glove80 User Guide](https://docs.moergo.com/glove80-user-guide/).
-- [Glove80 Troubleshooting](https://docs.moergo.com/troubleshooting-faqs/).
-- MoErgo's [Glove80 Support](https://moergo.com/glove80-support) page.
-- MoErgo's [Discord Server](https://moergo.com/discord).
-
-- [ZMK Documentation](https://zmk.dev/docs).
-- ZMK's [Discord Server](https://discord.gg/8cfMkQksSB).
-
-- MoErgo's [ZMK Distribution](https://github.com/moergo-sc/zmk).
-
-[magic layer]: #moergos-magic-layer
-[automatic builds]: https://github.com/MattSturgeon/glove80-config/actions/workflows/build.yml
-[@nickcoutsos]: https://github.com/nickcoutsos
-[@caksoylar]: https://github.com/caksoylar
-[Keymap Editor]: https://github.com/nickcoutsos/keymap-editor
-[Keymap Drawer]: https://github.com/caksoylar/keymap-drawer
+```sh
+nix run
+```

config/glove80.conf

@@ -1 +0,0 @@
-