https://github.com/amtoine/plank_ez.qmk
The QMK configuration for my Plank EZ mechanical keyboard.
https://github.com/amtoine/plank_ez.qmk
Last synced: 3 months ago
JSON representation
The QMK configuration for my Plank EZ mechanical keyboard.
- Host: GitHub
- URL: https://github.com/amtoine/plank_ez.qmk
- Owner: amtoine
- License: gpl-3.0
- Created: 2024-09-07T09:34:59.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-09-07T11:15:55.000Z (9 months ago)
- Last Synced: 2024-11-22T04:12:53.384Z (7 months ago)
- Language: C
- Size: 51.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Building your layout from source
Congratulations on taking the next step, and making use of your keyboard's open-source nature! There's so much power to unlock — this is going to be fun. :)
Here are some initial pointers to get you started:
- Use the documentation at [docs.qmk.fm](https://docs.qmk.fm/) to set up your environment for building your firmware.
- Build your layout against [github.com:zsa/qmk_firmware](https://github.com/zsa/qmk_firmware/) which is our _QMK_ fork (instead of `qmk/qmk_firmware`). This is what _Oryx_, the graphical configurator, uses, so it's guaranteed to work.
- Create a directory with a simple name (no spaces!) for your layout inside the `qmk_firmware/keyboards/planck/ez/glow/keymaps/` directory.
- Copy the contents of the `*_source` directory (in the ZIP you downloaded from _Oryx_) into this directory.
- Make sure you've set up your environment per the [QMK docs](https://docs.qmk.fm/#/newbs_getting_started?id=set-up-your-environment) so compilation would actually work.
- From your shell, make sure your working directory is `qmk*firmware`, then enter the following command
```shell
make planck/ez/glow:_layout_
```
, substituting the name of the directory you created for "_layout_".
Good luck on your journey! And remember, if you get stuck, you can always get back to your [original layout](https://configure.zsa.io/planck-ez/layouts/BPPYD/EjlgQ/0) from _Oryx_.