{"id":15606028,"url":"https://github.com/paulfioravanti/qmk_keymaps","last_synced_at":"2025-06-20T17:07:46.841Z","repository":{"id":145917258,"uuid":"142509862","full_name":"paulfioravanti/qmk_keymaps","owner":"paulfioravanti","description":"Personal custom keymaps for mechanical keyboards running QMK firmware","archived":false,"fork":false,"pushed_at":"2024-10-31T00:57:43.000Z","size":167,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-20T17:06:51.032Z","etag":null,"topics":["ergodox","ergodox-ez","georgi","mechanical-keyboard","multisteno","qmk","qmk-firmware","steno","stenography"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/paulfioravanti.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-07-27T00:53:55.000Z","updated_at":"2025-06-10T20:49:35.000Z","dependencies_parsed_at":"2023-11-06T05:23:56.682Z","dependency_job_id":"5b861755-ff96-4940-b92a-669719c11c2a","html_url":"https://github.com/paulfioravanti/qmk_keymaps","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/paulfioravanti/qmk_keymaps","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paulfioravanti%2Fqmk_keymaps","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paulfioravanti%2Fqmk_keymaps/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paulfioravanti%2Fqmk_keymaps/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paulfioravanti%2Fqmk_keymaps/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/paulfioravanti","download_url":"https://codeload.github.com/paulfioravanti/qmk_keymaps/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paulfioravanti%2Fqmk_keymaps/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260985173,"owners_count":23092885,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ergodox","ergodox-ez","georgi","mechanical-keyboard","multisteno","qmk","qmk-firmware","steno","stenography"],"created_at":"2024-10-03T04:20:45.886Z","updated_at":"2025-06-20T17:07:41.799Z","avatar_url":"https://github.com/paulfioravanti.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# QMK Keymaps\n\nCustom keymaps I have made for mechanical keyboards running [QMK Firmware][].\n\n## Blog Posts\n\nLots of tinkering with keyboard layouts has resulted in what I learned taking up\na fair share of content on [my blog][].\n\nI wrote a post about getting started with creating a QMK keyboard layout.\nAlthough it is quite [Ergodox][]-centric, I think there is still enough general\nQMK content in there to be of use if you use any other type of keyboard:\n\n- _[Escape the defaults and Control your keyboard with QMK][]_\n\nThe creation of the [`GS_TIMESTAMP`][] custom keycode, which inserts a current\ntimestamp into a [Google Sheets][] cell, ended up being far more involved that\nI originally thought, so I wrote up a blog post about that:\n\n- _[All I want is a Timestamp][]_\n\nCompilation and customisation of the Georgi layout, in particular its [Gaming\nmode][Georgi Gaming Mode], was the subject of the following blog post:\n\n- _[Flashing Georgi Firmware][]_\n\nGetting the [Georgi][] to play [Doom Typist][Typist.pk3] was the subject of the\nfollowing blog post:\n\n- _[Steno Gaming: Doom Typist][]_\n\n## Dependencies\n\nIn order to create a build environment, I followed the instructions on the\n[Setting Up Your QMK Environment][] page of the [QMK Documentation][].\n\nI use Mac OS, so the tools needed to compile the layout are listed in the\n[macOS section][macOS build tools], and are installed using [Homebrew][]:\n\n```sh\nbrew tap qmk/qmk\nbrew install qmk\nqmk setup\n```\n\n## Install\n\n```sh\ngit clone git@github.com:qmk/qmk_firmware.git\ngit clone git@github.com:paulfioravanti/qmk_keymaps.git\n```\n\n### Limitations\n\nQMK's stenography functionality went through a significant refactor in [this\ncommit][QMK steno refactor commit], making some of the steno firmware overrides\nin this repo incompatible with the current QMK `master` branch.\n\nTherefore, these customisations will currently only work on a version of QMK\ncreated before that refactor occurred. So, until those fixes are made, checkout\n[this commit][QMK steno refactor commit - 1] of QMK before copying over the\nkeymaps:\n\n```sh\ncd qmk_firmware\ngit checkout 2239527871deef1253ebe885df167726a100f971\ngit switch -c pre-process-steno-refactor\ncd ..\n```\n\nHopefully, this section can be removed at some point.\n\n### Copy Keymaps\n\nUse [rsync][] to merge this repository's `keyboards` directory into the QMK\nFirmware repository's `keyboards` directory:\n\n```sh\nrsync --recursive qmk_keymaps/keyboards/ qmk_firmware/keyboards/\n```\n\n### Copy Steno Firmware Overrides\n\nIf you plan to use the stenography firmware overrides that allow you to:\n\n- auto-repeat chords\n- hold down common keys between chords\n\nthen merge over the contents in the `quantum` directory as well:\n\n```sh\nrsync --recursive qmk_keymaps/quantum/ qmk_firmware/quantum/\n```\n\n\u003e Many thanks go to [Joshua Grams][] for putting up the code for this in his\n\u003e [steno-firmware][] repo!\n\nDetails about firmware compilation and setup are on the `README` page for the\nspecific keymap layout.\n\n## Flashing Firmware\n\nQMK has its own tool, [QMK Toolbox][], for flashing firmware. If it seems a bit\ntoo technical for you, and you own an Ergodox EZ, you may have luck with other\ntools. See Ergodox EZ layout README file for details.\n\n## Handy Links\n\n- [QMK Keycodes][] - what keycodes are currently available to you\n- [QMK Config Options][] - Helps determine what can go in the `config.h` file\n- [QMK Customizing Functionality][] - how to define new keycodes and process\n  them\n\n[All I want is a Timestamp]: https://www.paulfioravanti.com/blog/google-sheets-timestamp/\n[Ergodox]: https://ergodox-ez.com/\n[Escape the defaults and Control your keyboard with QMK]: https://www.paulfioravanti.com/blog/escape-defaults-control-keyboard-qmk/\n[Flashing Georgi Firmware]: https://www.paulfioravanti.com/blog/flashing-georgi-firmware/\n[Georgi]: https://www.gboards.ca/product/georgi\n[Georgi Gaming Mode]: http://docs.gboards.ca/docs/Unboxing-Georgi/#entering-qmk-gaming-mode\n[Google Sheets]: https://www.google.com/sheets/about/\n[`GS_TIMESTAMP`]: https://github.com/paulfioravanti/qmk_keymaps/blob/master/keyboards/ergodox_ez/keymaps/paulfioravanti/user/process_record_user.c#L104\n[Homebrew]: https://brew.sh/\n[Joshua Grams]: https://github.com/JoshuaGrams\n[macOS build tools]: https://docs.qmk.fm/#/getting_started_build_tools?id=macos\n[my blog]: https://www.paulfioravanti.com/\n[QMK Config Options]: https://docs.qmk.fm/#/config_options\n[QMK Customizing Functionality]: https://docs.qmk.fm/#/custom_quantum_functions\n[QMK documentation]: https://docs.qmk.fm/#/\n[QMK Firmware]: https://qmk.fm/\n[QMK Keycodes]: https://docs.qmk.fm/#/keycodes\n[QMK steno refactor commit]: https://github.com/qmk/qmk_firmware/commit/7060cb7b267e78ba693a77a3346c77c2d4209b01\n[QMK steno refactor commit - 1]: https://github.com/qmk/qmk_firmware/commit/2239527871deef1253ebe885df167726a100f971\n[QMK Toolbox]: https://github.com/qmk/qmk_toolbox\n[rsync]: http://en.wikipedia.org/wiki/Rsync\n[Setting Up Your QMK Environment]: https://docs.qmk.fm/#/newbs_getting_started\n[steno-firmware]: https://github.com/JoshuaGrams/steno-firmware\n[Steno Gaming: Doom Typist]: https://www.paulfioravanti.com/blog/steno-gaming-doom-typist/\n[Typist.pk3]: https://github.com/mmaulwurff/typist.pk3\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaulfioravanti%2Fqmk_keymaps","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpaulfioravanti%2Fqmk_keymaps","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaulfioravanti%2Fqmk_keymaps/lists"}