README.md

Josukey

A keyboard for Joey

This is an ergogen based corne clone that I intend to modify and tweak as I descend into the rabbit hole

V1

Prerequisites

• Node
• Docker

Getting Started

Get my files on your computer 😏 and install dependencies.

git clone https://github.com/Narkoleptika/josukey.git
cd josukey
npm i

Ergogen

Build

This will run Ergogen and build all of the output files.

npm run ergogen:build

Watch

This will watch the config.yaml file and the footprints directory and run the build command whenever there are changes.

npm run ergogen:watch

ZMK

Init

Downloads ZMK dependencies

npm run zmk:update

Build

Builds the ZMK firmware

npm run zmk:build

Down

Shuts down the ZMK docker services

npm run zmk:down

Thanks

• Ergogen
• Absolem Club Discord
• V4 Migration Guide
• Claw
• MrKeyboard
• Corne keyboard
• ZMK
• Miryoku ZMK