Skip to content

Commit

Permalink
ZMK Studio
Browse files Browse the repository at this point in the history
  • Loading branch information
Nicell committed Dec 3, 2024
1 parent 84d6d73 commit d4fa786
Show file tree
Hide file tree
Showing 14 changed files with 26 additions and 6 deletions.
16 changes: 13 additions & 3 deletions docs/build-guides/corne-wireless/firmware.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,25 @@ import DefaultKeymap5Col from './5_col_default_keymap.svg';

If you're not familiar, ZMK is a wireless-focused firmware, and it powers our Corne Wireless. While it doesn't have a VIA alternative yet, it does allow you to build firmware in the cloud.

If you want to test out the Corne firmware on your keyboard, you can use our test files. These are pre-compiled but are not guaranteed to have the most up-to-date version of ZMK. Check how to install these files in the ["Installing Firmware"](#installing-firmware) section at the bottom of this page
If you want to get running quickly, you can use our default firmware files. These are pre-compiled but are not guaranteed to have the most up-to-date version of ZMK. Check how to install these files in the ["Installing Firmware"](#installing-firmware) section at the bottom of this page

## Corne Test Files
## Corne Firmware Files

| | ⬅️ Left Half | ➡️ Right Half |
|------------------|--------------|---------------|
| 🚫 **nice!view** |[Download](/assets/6_col_corne_left-nice_nano_v2-zmk.uf2)|[Download](/assets/6_col_corne_right-nice_nano_v2-zmk.uf2)|
|**nice!view** |[Download](/assets/6_col_corne_left-nice_view_adapter-nice_view-nice_nano_v2-zmk.uf2)|[Download](/assets/6_col_corne_right-nice_view_adapter-nice_view-nice_nano_v2-zmk.uf2)|

## Keymap Customization with ZMK Studio

ZMK Studio provides runtime update functionality to ZMK powered devices, allowing users to change their keymap layers without flashing new firmware to their keyboards.

The firmware files provided above are compatible with ZMK Studio. You can use the firmware files to flash your Lily58 Wireless and then use ZMK Studio to customize your keymap.

You can use ZMK Studio with Chrome/Edge at https://zmk.studio/. The web app does not support updating via BLE, but the native app does.

To use the native app for Linux, macOS, or Windows, download the appropriate file from the [latest release](https://github.com/zmkfirmware/zmk-studio/releases).

### Default Keymap

<DefaultKeymap6Col className="keymap" />
Expand All @@ -26,7 +36,7 @@ If you want to test out the Corne firmware on your keyboard, you can use our tes
<details>
<summary>5 Column Corne</summary>

## 5 Column Corne Test Files
## 5 Column Corne Firmware Files

| | ⬅️ Left Half | ➡️ Right Half |
|------------------|--------------|---------------|
Expand Down
16 changes: 13 additions & 3 deletions docs/build-guides/lily58-wireless/firmware.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,25 @@ import DefaultKeymap from './default_keymap.svg';

If you're not familiar, ZMK is a wireless-focused firmware, and it powers our Lily58 Wireless. While it doesn't have a VIA alternative yet, it does allow you to build firmware in the cloud.

## Test Files
## Firmware Files

If you want to test out the Lily58 firmware on your keyboard, you can use our test files. These are pre-compiled but are not guaranteed to have the most up-to-date version of ZMK. Check how to install these files in the ["Installing Firmware"](#installing-firmware) section at the bottom of this page
If you want to get running quickly, you can use our default firmware files. These are pre-compiled but are not guaranteed to have the most up-to-date version of ZMK. Check how to install these files in the ["Installing Firmware"](#installing-firmware) section at the bottom of this page

| | ⬅️ Left Half | ➡️ Right Half |
|------------------|--------------|---------------|
| 🚫 **nice!view** |[Download](/assets/lily58_left-nice_nano_v2-zmk.uf2)|[Download](/assets/lily58_right-nice_nano_v2-zmk.uf2)|
|**nice!view** |[Download](/assets/lily58_left-nice_view_adapter-nice_view-nice_nano_v2-zmk.uf2)|[Download](/assets/lily58_right-nice_view_adapter-nice_view-nice_nano_v2-zmk.uf2)|

## Keymap Customization with ZMK Studio

ZMK Studio provides runtime update functionality to ZMK powered devices, allowing users to change their keymap layers without flashing new firmware to their keyboards.

The firmware files provided above are compatible with ZMK Studio. You can use the firmware files to flash your Lily58 Wireless and then use ZMK Studio to customize your keymap.

You can use ZMK Studio with Chrome/Edge at https://zmk.studio/. The web app does not support updating via BLE, but the native app does.

To use the native app for Linux, macOS, or Windows, download the appropriate file from the [latest release](https://github.com/zmkfirmware/zmk-studio/releases).

## Default Keymap

<DefaultKeymap className="keymap" />
Expand All @@ -26,7 +36,7 @@ If you want to test out the Lily58 firmware on your keyboard, you can use our te

With the nature of a small keyboard like the Lily58, you're likely interested in making a custom keymap for it.

We've created ZMK config repositories for the Lily58 Wireless for you to use as a template for yourself. If you'd like to set it up manually, follow the [ZMK documentation](https://zmk.dev/docs/user-setup).
We've created ZMK config repositories for the Lily58 Wireless for you to use as a template for yourself. If you'd like to set it up manually, follow the [ZMK documentation](https://zmk.dev/docs/user-setup).

| 🚫 nice!view | ✅ nice!view |
|------------------|--------------|
Expand Down
Binary file modified static/assets/5_col_corne_left-nice_nano_v2-zmk.uf2
Binary file not shown.
Binary file not shown.
Binary file modified static/assets/5_col_corne_right-nice_nano_v2-zmk.uf2
Binary file not shown.
Binary file not shown.
Binary file modified static/assets/6_col_corne_left-nice_nano_v2-zmk.uf2
Binary file not shown.
Binary file not shown.
Binary file modified static/assets/6_col_corne_right-nice_nano_v2-zmk.uf2
Binary file not shown.
Binary file not shown.
Binary file modified static/assets/lily58_left-nice_nano_v2-zmk.uf2
Binary file not shown.
Binary file not shown.
Binary file modified static/assets/lily58_right-nice_nano_v2-zmk.uf2
Binary file not shown.
Binary file not shown.

0 comments on commit d4fa786

Please sign in to comment.