For reference here's what my folder structure looks like so far: It's in your keyboard project folder where the rest of your code will go. So your directory structure should look like this: I'm sure the info is in there, but I couldn't see it all in once place.Īnyway, we want to create a folder to put all your personal related files under the keyboards subdir in the qmk_firmware folder. File Structureįollowing the QMK docs, this is right where they lost me in creating my own keyboard. If you want to get your stuff in their repo later after following this guide, you can always go back and clean up your files late. I won't rehash them here, and I don't intend on pushing my little personal project upstream.
#KEYBOARD LAYOUT EDITOR PROGRAM HOW TO#
There's guidelines in the QMK docs about how to name and format your files for doing a pull-request to get your contributions back into the main repo. It'll let you know where it's going to install the firmware, and that's where we'll save our source code too. I personally used Ubuntu through WSL on Windows 10 to install QMK and compile my firmware and had no issues, but they have instructions on all operating systems. The QMK website has pretty good documentation on getting everything installed with their getting started page here. I suggest saving your layout in KLE so you can refer back to it later. The main thing we'll need from here is the JSON text found under the Raw data tab at the bottom. Even better for me, the default layout when you load up the webpage is a simple numpad - exactly my layout! The UI is pretty user friendly, and there's presets for common keyboard layouts. I plan on doing a log on my hardware design, and this will feature in that step too. Often referred to as KLE, this tool is super handy for planning out your dream keyboard, even if the hardware doesn't exist yet.
0 kommentar(er)
