Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bluedrink9/zmk_maizeless

ZMK config for the Maizeless keyboard.
https://github.com/bluedrink9/zmk_maizeless

Last synced: about 6 hours ago
JSON representation

ZMK config for the Maizeless keyboard.

Awesome Lists containing this project

README 

        
 # Maizeless Custom Configuration



 ![Maizeless Logo](maizeless_logo.svg)



This repo contains ZMK configuration for the [Maizeless keyboard](https://github.com/BlueDrink9/maizeless) hardware.

It contains my personal keymap layout, but can be forked to make it your own (and it defaults to the Corne layout when not customised/no `.keymap`).

To modify it, make changes to `maizeless.keymap`.



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, rather than setting up the tool chain on your local computer.

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).



 ## Resources

 - The [official ZMK Firmware GitHub](https://github.com/zmkfirmware/zmk) repository. View the keymaps for other boards and shields as a starting point for your keymap.

 - 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!



 ## Instructions

 1. Log into, or sign up for, your personal GitHub account.

 2. Fork this repository to your local computer, and then push it to your GitHub personal account. ([instructions](https://docs.github.com/en/get-started/quickstart/fork-a-repo))

 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.



 ## Firmware Files

 To locate your firmware files:

 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.

 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 "firmware.zip"

 5. Download the firmware zip archive and extract the two .uf2 files. They are named according to which side they need to be flashed to.

 6. Plug your main (usually left) board into the computer

 7. Flash the firmware to your keyboard by double-tapping/quickly double bridging the reset pads, e.g. by touching them with a key, to put the it in bootloader mode (the red LED should blink then go solid). This will set the board up as a disk for your computer to mount. A file explorer window should pop up showing the contents of the storage on the keyboard. Drag and drop the correct .uf2 file into the window. When the upload is complete the window will close and the keyboard will exit bootloader mode.



 Your keyboard is now ready to use.



## Layout drawings

SVGs that draw the layout are also created as part of the Github actions.

Find the artifacts at the bottom of the drawing workflow.



## Local build and creating a layout drawing



The makefile contains flashing and building shortcuts, if you choose to do local builds.

However, most people will find it more useful for the `make draw` option. This will create an svg and pdf drawing of the keyboard layout using [keymap-drawer](https://github.com/caksoylar/keymap-drawer) (which must be installed and on PATH for the makefile option to work).

You also need inkscape installed to convert the svg to the output pdf.