diff options
| author | Tsan-Kuang Lee <1425438+tsankuanglee@users.noreply.github.com> | 2019-11-05 01:14:15 -0600 |
|---|---|---|
| committer | Drashna Jaelre <drashna@live.com> | 2019-11-04 23:14:15 -0800 |
| commit | 8b832c494cd6d50e4f9c8384ce54733308eda95f (patch) | |
| tree | aa86f942fcabf6df270a4baa9160ba87bb9803e0 /keyboards/ergodox_ez/util/readme.md | |
| parent | dcb2d63302fefe1b37b8ca606ce7241ae8655389 (diff) | |
[Keyboard] add keymap beautifier for Ergodox EZ (#4393)
* add beautifier
* add example
* Update keyboards/ergodox_ez/util/keymap_beautifier.py
Co-Authored-By: tsankuanglee <1425438+tsankuanglee@users.noreply.github.com>
* Update keyboards/ergodox_ez/util/keymap_beautifier.py
Co-Authored-By: tsankuanglee <1425438+tsankuanglee@users.noreply.github.com>
* works for regular layout
* all planned features implemented
* add justification switch
* docker support
* doc and starting script
* clean up the container after done
Diffstat (limited to 'keyboards/ergodox_ez/util/readme.md')
| -rw-r--r-- | keyboards/ergodox_ez/util/readme.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/keyboards/ergodox_ez/util/readme.md b/keyboards/ergodox_ez/util/readme.md index 26c5e5d99c..deb0cad5db 100644 --- a/keyboards/ergodox_ez/util/readme.md +++ b/keyboards/ergodox_ez/util/readme.md @@ -1,3 +1,11 @@ # ErgoDox EZ Utilities +## compile_keymap.py + The Python script in this directory, by [mbarkhau](https://github.com/mbarkhau) allows you to write out a basic ErgoDox EZ keymap using Markdown notation, and then transpile it to C, which you can then compile. It's experimental, but if you're not comfortable using C, it's a nice option. + +## keymap_beautifier.py + +This Python 3 script, by [Tsan-Kuang Lee](https://github.com/tsankuanglee) takes the keymap.c downloaded from [ErgoDox EZ Configurator](https://configure.ergodox-ez.com/) and beautifies it for easier customization, allowing one to quickly draft a layout to build upon. + +See [README.md](./keymap_beautifier/README.md) for this utility for more details. |