⌨️ Open-source keyboard firmware for Atmel AVR and Arm USB families
Find a file
James Young 69719db6e9
Bathroom Epiphanies Ghost Squid Refactor (#18816)
* refactor default keymap

- shorten layer names
  - KM_QWERTY -> _QW
  - KM_MEDIA -> _MD
  - KM_GUI_LOCK -> _GL
- use QMK-native keycode aliases
- use four-space indent
- grid-align keycodes

* remove third layer from default keymap

The third layer only serves to disable the GUI keys, which we can do with a keycode.

* update default keymap readme

* ghost_squid.h: add matrix diagram

* add LAYOUT_fullsize_ansi

* add LAYOUT_fullsize_iso

* use LAYOUT_fullsize_iso macro in default keymap

Refactor the default keymap to use the new LAYOUT_fullsize_iso macro.

* remove LAYOUT macro

Same matrix as LAYOUT_fullsize_iso, but in a different assignment order.

* enable Community Layout support
2022-10-22 21:48:29 +01:00
.github Bump JamesIves/github-pages-deploy-action from 4.4.0 to 4.4.1 (#18702) 2022-10-13 23:27:03 +01:00
.vscode Exclude uf2 files in VS Code (#18186) 2022-08-28 09:59:07 -07:00
builddefs docs: some typos (#18582) 2022-10-05 17:32:07 +01:00
data DD mappings for build.debounce_type and backlight.levels (#18628) 2022-10-06 22:58:13 -07:00
docs [Docs] Fix link to keyboard layout editor (#18801) 2022-10-22 12:39:49 -07:00
drivers Keychron Q3 I2C & CKLED2001 transfer speedup (#18780) 2022-10-20 18:20:47 -07:00
keyboards Bathroom Epiphanies Ghost Squid Refactor (#18816) 2022-10-22 21:48:29 +01:00
layouts fix: Remove TERM_ON/TERM_OFF from my keymap (#18354) 2022-09-14 01:20:34 +01:00
lib Remove unused LED_INDICATORS constant (#18686) 2022-10-12 22:40:53 +01:00
platforms Allow Fedora to update ChibiOS configs. (#18698) 2022-10-17 07:30:49 +11:00
quantum docs: some typos (#18582) 2022-10-05 17:32:07 +01:00
tests Remove legacy keycodes from unit tests (#18430) 2022-09-20 08:52:43 +02:00
tmk_core GMMK2: Fix 'ISO' within product name (#18322) 2022-09-10 13:31:46 +01:00
users Adjust oled gen to fix flashing on timeout (#18747) 2022-10-19 01:40:26 +01:00
util Allow Fedora to update ChibiOS configs. (#18698) 2022-10-17 07:30:49 +11:00
.clang-format Clang-format tweaks (#15906) 2022-02-11 20:00:34 -08:00
.editorconfig QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
.gitattributes eol=lf, where appropriate (#15752) 2022-01-05 21:56:31 +00:00
.gitignore Add .orig to .gitignore (#17626) 2022-07-17 04:38:56 +10:00
.gitmodules [Core] Add Raspberry Pi RP2040 support (#14877) 2022-06-30 13:19:27 +02:00
Dockerfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2021-08-29 16:41:56 -07:00
Doxyfile Internal docs generation updates (#16411) 2022-02-21 15:47:44 +00:00
doxygen-todo Remove SERIAL_LINK feature (#14727) 2021-10-07 12:32:05 +11:00
LICENSE add an explicit lisence file for github to pickup 2017-11-13 20:50:54 -05:00
license_GPLv2.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_GPLv3.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_Modified_BSD.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
Makefile docs: some typos (#18582) 2022-10-05 17:32:07 +01:00
nose2.cfg Setup a python test framework 2019-09-07 07:58:41 -07:00
paths.mk Migrate more makefile utilities to builddefs sub-directory (#16002) 2022-02-10 09:45:51 -08:00
readme.md 2022q3 Changelog. (#18180) 2022-08-28 14:20:52 +10:00
requirements-dev.txt Macros in JSON keymaps (#14374) 2021-11-22 11:11:35 -08:00
requirements.txt Align CLI requirements (#18117) 2022-08-21 18:38:17 +01:00
setup.cfg Quantum Painter (#10174) 2022-04-13 18:00:18 +10:00
shell.nix Nix shell updates for develop (#18131) 2022-08-23 02:59:33 +01:00
Vagrantfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2021-08-29 16:41:56 -07:00

Quantum Mechanical Keyboard Firmware

Current Version Discord Docs Status GitHub contributors GitHub forks

This is a keyboard firmware based on the tmk_keyboard firmware with some useful features for Atmel AVR and ARM controllers, and more specifically, the OLKB product line, the ErgoDox EZ keyboard, and the Clueboard product line.

Documentation

The docs are powered by Docsify and hosted on GitHub. They are also viewable offline; see Previewing the Documentation for more details.

You can request changes by making a fork and opening a pull request, or by clicking the "Edit this page" link at the bottom of any page.

Supported Keyboards

The project also includes community support for lots of other keyboards.

Maintainers

QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, Hasu. The OLKB product firmwares are maintained by Jack Humbert, the Ergodox EZ by ZSA Technology Labs, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.

Official Website

qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.