Skip to content

Commit 1bcb1e2

Browse files
committed
build errors
1 parent 34ea6ff commit 1bcb1e2

File tree

1 file changed

+24
-18
lines changed

1 file changed

+24
-18
lines changed

guides/zmkGui.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
2-
title: ZMK GUI
2+
title: Getting started with a ZMK GUI
33
description: How to use a GUI to configure your ZMK powered keyboard.
44
author: Boardsource
5+
product_link: https://www.boardsource.xyz/products/supermini
56
subcategory: easy
67
draft: false
78
tags:
@@ -30,15 +31,15 @@ or integrated if there is no controller that a user solders to the board.
3031

3132
| Nice!Nano/SuperMini | Blok | Integrated |
3233
|---------------------------------------------------------------------------|------|------------|
33-
| [Corne](https://github.com/boardsource/zmk-config_corne_nnv2) | | |
34-
| [Lily58/Lulu](https://github.com/boardsource/zmk-config_lily58_nnv2) | | |
35-
| [Microdox v2](https://github.com/boardsource/zmk-config_microdoxv2_nnv2) | | |
36-
| [Sweep](https://github.com/boardsource/zmk-config_sweep_nnv2) | | |
37-
| [TG4X](https://github.com/boardsource/zmk-config_tg4x_nnv2) | | |
38-
| [3x4 Macropad](https://github.com/boardsource/zmk-config_3x4_nnv2) | | |
39-
| [Sofle](https://github.com/boardsource/zmk-config_sofle_nnv2) | | |
34+
| [Corne](https://github.com/boardsource/zmk-config_corne_nnv2) | x | x |
35+
| [Lily58/Lulu](https://github.com/boardsource/zmk-config_lily58_nnv2) | x | x |
36+
| [Microdox v2](https://github.com/boardsource/zmk-config_microdoxv2_nnv2) | x | x |
37+
| [Sweep](https://github.com/boardsource/zmk-config_sweep_nnv2) | x | x |
38+
| [TG4X](https://github.com/boardsource/zmk-config_tg4x_nnv2) | x | x |
39+
| [3x4 Macropad](https://github.com/boardsource/zmk-config_3x4_nnv2) | x | x |
40+
| [Sofle](https://github.com/boardsource/zmk-config_sofle_nnv2) | x | x |
4041

41-
# Step 2: Create a reposity from the template.
42+
# Step 2: Create a repository from the template.
4243

4344
You will need a GitHub account for this. If you don't have one, take a moment
4445
now to create one. Not only does this make working with ZMK easier, it means
@@ -47,33 +48,38 @@ Once you have an account, and are logged in, you'll create a repository for your
4748
keyboard like this. Make sure to name the repository something you'll remember.
4849
Many people use `zmk-keyboardNameHere`
4950

50-
![](https://images.boardsource.xyz/template%20how%20to.png)
51+
![how to get template](https://images.boardsource.xyz/template%20how%20to.png)
5152

52-
# Step 3: Connect the GUI tool to the reposity you created
53+
# Step 3: Connect the GUI tool to the repository you created
5354

5455
At this point, we are almost there! We'll want to go to [the keymap
5556
editor](https://nickcoutsos.github.io/keymap-editor/) and follow the
5657
instructions given. It will want you to connect your code from GitHub to the
5758
tool so it can access and edit your keymap all in the tool.
5859

59-
# Step 4: Getting the files for your keyboard
60+
# Step 4: Make changes to your keymap
61+
Click on any key displayed on your keyboard. You should see a popup that lets you change the function of that key. Make any changes you want and move on to the next step.
6062

61-
![](https://images.boardsource.xyz/signal-2023-10-20-120918_002.png)
63+
# Step 5: Getting the files for your keyboard
6264

63-
![](https://images.boardsource.xyz/signal-2023-10-20-120918_003.png)
65+
![how to save changes](https://images.boardsource.xyz/signal-2023-10-20-120918_002.png)
6466

6567
We have everything we want, and just have to put it on the keyboard.
6668
In the editor, there's a save icon at the top. Make sure to hit that, and then
6769
the button to the right. That will take you back to GitHub to get your firmware,
68-
built automatically for you! If you see a yellow spinning icon or text like `0/2
70+
built automatically for you!
71+
72+
![how to download Firmware](https://images.boardsource.xyz/signal-2023-10-20-120918_003.png)
73+
74+
If you see a yellow spinning icon or text like `0/2
6975
jobs completed`, just wait a moment while it does the compiling for you. It may
7076
take just a minute or two. Once it's all green, you'll see a file in the
71-
Artifacts section called `firmware.zip`. Click that and download it. That will
72-
be your firmware ready to go for your board! Make sure to extract the zip into
77+
Artifacts section called `firmware.zip`. Click that to download it. That's
78+
your firmware ready to go for your board! Make sure to extract the zip into
7379
UF2 files. Split keyboards get 2 firmware. One for left, and one for right.
7480
Make sure to not mix them up.
7581

76-
# Step 5: Flashing
82+
# Step 6: Flashing
7783

7884
This is the normal process for flashing your controller. With most controllers,
7985
you can double tap reset, and you'll have a "flash drive" show up on your

0 commit comments

Comments
 (0)