Skip to content

Commit

Permalink
update to jlw
Browse files Browse the repository at this point in the history
  • Loading branch information
josh-l-wang committed Oct 21, 2024
1 parent aa05002 commit 65fbc57
Show file tree
Hide file tree
Showing 22 changed files with 176 additions and 4,586 deletions.
14 changes: 4 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# MechWild's ZMK User Config Repo
# jlw's ZMK User Config Repo

## Instructions

Expand All @@ -8,20 +8,14 @@
2. Navigate to the **Actions** tab and click the "I understand my workflows, go ahead and run them" button to enable builds.

![Actions tab with "I understand my workflows" button](https://i.imgur.com/B7cTAE6.png)
3. Edit the files for your keyboard(s) in the [`config`](config/) folder. `.conf` files configure keyboard features, and `.keymap` files change the keymap. Settings in `default.conf` will apply to all keyboards; to make keyboard-specific changes, create a file named after the keyboard (e.g. `bb40.conf`) and change the settings there.
3. Edit the files for your keyboard(s) in the [`config`](config/) folder. `.conf` files configure keyboard features, and `.keymap` files change the keymap. Settings in `default.conf` will apply to all keyboards; to make keyboard-specific changes, create a file named after the keyboard (e.g. `jlwffre.conf`) and change the settings there.
4. Edit the [`build.yaml`](build.yaml) file to include the board(s) and/or shield(s) you need to build firmware for.
5. After committing your changes, your firmware will begin compiling. Assuming there are no typos or other problems, it will eventually be [downloadable from the Actions tab](https://zmk.dev/docs/user-setup#installing-the-firmware).
6. [Flash the firmware](https://zmk.dev/docs/user-setup#flashing-uf2-files) that matches the board and/or shield you're using, e.g. `bb40-pillbug-zmk.uf2` for a BB40 using a PillBug.
6. [Flash the firmware](https://zmk.dev/docs/user-setup#flashing-uf2-files) that matches the board and/or shield you're using, e.g. `jlwffre-zmk.uf2`.

### Already have a ZMK user config repo?

The keymaps here may still be useful, but you probably want to [add the `mechwild-zmk-keyboards` ZMK module](https://github.com/lesshonor/mechwild-zmk-keyboards#instructions) to your existing `west` manifest instead.

### Want to know more?

Check the [MechWild ZMK module](https://github.com/lesshonor/mechwild-zmk-keyboards) for additional information such as:
- How to [switch to the mirrored layout on your Mokulua](https://github.com/lesshonor/mechwild-zmk-keyboards#alternate-keymap-transforms) (or use any other non-standard keymap layout)
- How [not to kill your nice!view](https://github.com/lesshonor/mechwild-zmk-keyboards#niceview-and-other-low-voltage-displays) (or other non-OLED display)
The keymaps here may still be useful, but you probably want to [add the `zmk-jlw-keyboards` ZMK module](https://github.com/josh-l-wang/zmk-jlw-keyboards) to your existing `west` manifest instead.

## Common Questions/Problems

Expand Down
2 changes: 1 addition & 1 deletion boards/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Hello. Most people won't need to do anything with this folder, but it does need to exist so the build doesn't print an unnecessary warning message.

If you have used this repository as a jumping-off point for a user-config repo for more than just MechWild: it is possible to add more boards and shields to this folder, but consider [creating a Zephyr module](https://zmk.dev/docs/development/new-shield#new-zephyr-module-repository) and adding them to the [`west` manifest](../config/west.yml) instead.
If you have used this repository as a jumping-off point for a user-config repo for more than just jlw boards: it is possible to add more boards and shields to this folder, but consider [creating a Zephyr module](https://zmk.dev/docs/development/new-shield#new-zephyr-module-repository) and adding them to the [`west` manifest](../config/west.yml) instead.
34 changes: 2 additions & 32 deletions build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,35 +11,5 @@
# artifact-name: corne_left_with_logging
---
include:
# - board: pillbug
# shield: bb40
# - board: pillbug
# shield: bb65
# - board: pillbug
# shield: bbpad
# - board: nice_nano_v2
# shield: bde_rev2
# - board: nice_nano_v2
# shield: mokulua_left
# - board: nice_nano_v2
# shield: mokulua_right
# - board: nice_nano_v2
# shield: murphpad
# - board: pillbug
# shield: obe
# - board: pillbug
# shield: waka60
- board: nice_nano
shield: settings_reset
- board: nice_nano_v2
shield: settings_reset
- board: pillbug@0.1
shield: settings_reset
- board: pillbug
shield: settings_reset
- board: blackpill_f401cc
shield: settings_reset
- board: blackpill_f401ce
shield: settings_reset
- board: blackpill_f411ce
shield: settings_reset
- board: le_jlwffre
shield: settings_reset
115 changes: 0 additions & 115 deletions config/bb40.json

This file was deleted.

59 changes: 0 additions & 59 deletions config/bb40.keymap

This file was deleted.

Loading

0 comments on commit 65fbc57

Please sign in to comment.