Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
MattSturgeon committed Sep 20, 2023
1 parent a4233d3 commit 95fae42
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 15 deletions.
61 changes: 46 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,65 @@
# MoErgo Glove80 Custom Configuration for ZMK
# My custom ZMK config for the MoErgo Glove80

![MoErgo Logo](moergo_logo.png)
![Layout](img/glove80_ColmakDH.svg)

This repo is the official ZMK configuration of the MoErgo Glove80 wireless split contoured keyboard. Use it to develop your own keymap and easily build your own ZMK firmware to run on your Glove80.
This repo contains my current keyboad config for my Glove80. It is based on the [official MoErgo Glove80 ZMK configuration](https://github.com/moergo-sc/glove80-zmk-config) and was initially built using MoErgo's [official Layout Editor](https://my.glove80.com), however now it is maintained using @nickcoutsos's excellent [Keymap Editor](https://github.com/nickcoutsos/keymap-editor) and the occarional manual tweaking of the `keymap` file.

**NOTE: You can also customize the layout of your Glove80 keyboard with the Glove80 Layout Editor webapp. For most users Glove80 Layout Editor is the recommended and simpler option. More information is available at the official MoErgo Glove80 Support site (see resources below).**

These steps will get you using your keymap on your keyboard in the fastest time possible. It uses the GitHub Actions feature to build your firmware online.

If you are looking to dig deeper into ZMK and develop new functionality, it is recommended to follow the steps of installing ZMK as found on the official ZMK documentation site (linked below).
The keyboard firmware is built automatically using MoErgo's Github Actionr CI Workflow. CI is also used to automatically render keymap images of each layer using @caksoylar's excellent [Keymap Drawer](https://github.com/caksoylar/keymap-drawer).

## Resources
- @nickcoutsos's [Keymap Editor](https://github.com/nickcoutsos/keymap-editor).
- @caksoylar's [Keymap Drawer](https://github.com/caksoylar/keymap-drawer).
- MoErgo's official [Layout Editor](https://my.glove80.com).
- The [official MoErgo Glove80 Support](https://moergo.com/glove80-support) web site. Glove80 documentation and other technical resources.
- The [official MoErgo Discord Server](https://moergo.com/discord). Instant conversations with other Glove80 users.

- The [official ZMK Documentation](https://zmk.dev/docs) web site. Find the answers to many of your questions about ZMK Firmware.
- The [official ZMK Discord Server](https://discord.gg/8cfMkQksSB). Instant conversations with other ZMK developers and users. Great technical resource!

- The [official Glove80 ZMK Distribution](https://github.com/moergo-sc/zmk). Repositiory for ZMK firmware customized for Glove80.

## Instructions
1. Log into, or sign up for, your personal GitHub account.
2. Create your own repository using this repository as a template ([instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)) and check it out on your local computer.
3. Edit the keymap file(s) to suit your needs
4. Commit and push your changes to your personal repo. Upon pushing it, GitHub Actions will start building a new version of your firmware with the updated keymap.

## Layers

### Base Layers

The main base layer is Colmak DH. Some punctuation is moved around uring Mod Morphs, and usuful stuff is placed on the thunb keys.

![Colmak DH](img/glove80_ColmakDH.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 accesible 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 utitities, such as bluetooth settings and RGB lighting config.

![Magic Layer](img/glove80_Magic.svg)

## Firmware Files
To locate your firmware files and reflash your Glove80...
1. log into GitHub and navigate to your personal config repository you just uploaded your keymap changes to.
2. Click "Actions" in the main navigation, and in the left navigation click the "Build" link.
2. Click ["Actions"](https://github.com/MattSturgeon/Glove80-Config/actions/workflows/build.yml) in the main navigation, and in the left navigation click the "Build" link.
3. Select the desired workflow run in the centre area of the page (based on date and time of the build you wish to use). You can also start a new build from this page by clicking the "Run workflow" button.
4. After clicking the desired workflow run, you should be presented with a section at the bottom of the page called "Artifacts". This section contains the results of your build, in a file called "glove80.uf2"
5. Download the glove80.uf2
Expand Down
Binary file removed moergo_logo.png
Binary file not shown.

0 comments on commit 95fae42

Please sign in to comment.