jordan
/
qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
master
rgb_matrix
planck_rev6
error_log_cleanup
info_json_docs
info_json_updates
keycode_versioning
readme-update
cb2x1800
new_project_fix
moxygen
clueboard_hotswap
handwire
twi2c
arm_audio_fixes
xmega_support
audio_out
gb_port
clueboard_1
info_json_populate
pjrc_hid
subvendor_ids
stm32l476
docs
matrix_update
ps2avrgb
travis_phases
dz_support
make_autocomplete
hid_api
clueboard_arm
sid
keyboards_json
keyboard_identifiers
pp_definitions
teensy_lc_synth
eeprom_update
process_keycode_update
b6_b7_audio
example_keyboards
preonic-1.0
planck-4.0
preonic-2.0
planck-5.0
planck-4.2
planck-4.1
ergodox_ez-161205
0.6.9
0.6.8
0.6.7
0.6.6
0.6.5
0.6.4
0.6.3
0.6.20
0.6.2
0.6.19
0.6.18
0.6.17
0.6.16
0.6.15
0.6.14
0.6.13
0.6.12
0.6.11
0.6.10
0.6.1
0.6.0
0.5.99
0.5.98
0.5.97
0.5.96
0.5.95
0.5.94
0.5.93
0.5.92
0.5.91
0.5.90
0.5.9
0.5.89
0.5.88
0.5.87
0.5.86
0.5.85
0.5.84
0.5.83
0.5.82
0.5.81
0.5.80
0.5.8
0.5.79
0.5.78
0.5.77
0.5.76
0.5.75
0.5.74
0.5.73
0.5.72
0.5.71
0.5.70
0.5.7
0.5.69
0.5.68
0.5.67
0.5.66
0.5.65
0.5.64
0.5.63
0.5.62
0.5.61
0.5.60
0.5.6
0.5.59
0.5.58
0.5.57
0.5.56
0.5.55
0.5.54
0.5.53
0.5.52
0.5.51
0.5.50
0.5.5
0.5.49
0.5.48
0.5.47
0.5.46
0.5.45
0.5.44
0.5.43
0.5.42
0.5.41
0.5.40
0.5.4
0.5.39
0.5.38
0.5.37
0.5.36
0.5.35
0.5.34
0.5.33
0.5.32
0.5.31
0.5.30
0.5.3
0.5.29
0.5.28
0.5.27
0.5.264
0.5.263
0.5.262
0.5.261
0.5.260
0.5.26
0.5.259
0.5.258
0.5.257
0.5.256
0.5.255
0.5.254
0.5.253
0.5.252
0.5.251
0.5.250
0.5.25
0.5.249
0.5.248
0.5.247
0.5.246
0.5.245
0.5.244
0.5.243
0.5.242
0.5.241
0.5.240
0.5.24
0.5.239
0.5.238
0.5.237
0.5.236
0.5.235
0.5.234
0.5.233
0.5.232
0.5.231
0.5.230
0.5.23
0.5.229
0.5.228
0.5.227
0.5.226
0.5.225
0.5.224
0.5.223
0.5.222
0.5.221
0.5.220
0.5.22
0.5.219
0.5.218
0.5.217
0.5.216
0.5.215
0.5.214
0.5.213
0.5.212
0.5.211
0.5.210
0.5.21
0.5.209
0.5.208
0.5.207
0.5.206
0.5.205
0.5.204
0.5.203
0.5.202
0.5.201
0.5.200
0.5.20
0.5.2
0.5.199
0.5.198
0.5.197
0.5.196
0.5.195
0.5.194
0.5.193
0.5.192
0.5.191
0.5.190
0.5.189
0.5.188
0.5.187
0.5.186
0.5.185
0.5.184
0.5.183
0.5.182
0.5.181
0.5.180
0.5.179
0.5.178
0.5.177
0.5.176
0.5.175
0.5.174
0.5.173
0.5.172
0.5.171
0.5.170
0.5.17
0.5.169
0.5.168
0.5.167
0.5.166
0.5.165
0.5.164
0.5.163
0.5.162
0.5.161
0.5.160
0.5.16
0.5.159
0.5.158
0.5.157
0.5.156
0.5.155
0.5.154
0.5.153
0.5.152
0.5.151
0.5.150
0.5.15
0.5.149
0.5.148
0.5.147
0.5.146
0.5.145
0.5.144
0.5.143
0.5.142
0.5.141
0.5.140
0.5.14
0.5.139
0.5.138
0.5.137
0.5.136
0.5.135
0.5.134
0.5.133
0.5.132
0.5.131
0.5.130
0.5.13
0.5.129
0.5.128
0.5.127
0.5.126
0.5.125
0.5.124
0.5.123
0.5.122
0.5.121
0.5.120
0.5.12
0.5.119
0.5.118
0.5.117
0.5.116
0.5.115
0.5.114
0.5.113
0.5.112
0.5.111
0.5.110
0.5.11
0.5.109
0.5.108
0.5.107
0.5.106
0.5.105
0.5.104
0.5.103
0.5.102
0.5.101
0.5.100
0.5.10
0.5.1
0.5.0
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '0092be5925'
${ noResults }
qmk_firmware/docs
History
fauxpark b713feb6f2 Add a little aside explaining that shifted keys with mod-tap doesn't work (#2446) 7 years ago
..
gitbook/images RGB improvements (#1684) 7 years ago
README.md Convert all headings to Title Case 7 years ago
_summary.md Convert all headings to Title Case 7 years ago
becoming_a_qmk_collaborator.md Convert all headings to Title Case 7 years ago
compatible_microcontrollers.md Convert all headings to Title Case 7 years ago
config_options.md Clarify that we actually have max 16 total backlight levels 7 years ago
contributing.md Trim trailing whitespace 7 years ago
custom_quantum_functions.md Fixed typo 7 years ago
documentation_best_practices.md Fix some of the more obvious typos 7 years ago
documentation_templates.md Make arguments redo, subproject elimination (#1784) 7 years ago
eclipse.md Fixed typo of 'confid.h' to 'config.h' (#2448) 7 years ago
faq.md Overhaul the Getting Started section and add a FAQ section 7 years ago
faq_build.md Minor updates to docs (#2406) 7 years ago
faq_debug.md Trim trailing whitespace 7 years ago
faq_general.md Convert all headings to Title Case 7 years ago
faq_keymap.md backlight breathing overhaul (#2187) 7 years ago
feature_advanced_keycodes.md Add a little aside explaining that shifted keys with mod-tap doesn't work (#2446) 7 years ago
feature_audio.md Fixed typo of 'confid.h' to 'config.h' (#2448) 7 years ago
feature_auto_shift.md Update feature_auto_shift.md 7 years ago
feature_backlight.md Clarify that we actually have max 16 total backlight levels 7 years ago
feature_bluetooth.md Format keycode tables 7 years ago
feature_bootmagic.md Document bootmagic hot keys 7 years ago
feature_dynamic_macros.md Trim trailing whitespace 7 years ago
feature_grave_esc.md Format keycode tables 7 years ago
feature_key_lock.md Convert all headings to Title Case 7 years ago
feature_layouts.md Clarify the format for layout names 7 years ago
feature_leader_key.md Convert all headings to Title Case 7 years ago
feature_macros.md Trim trailing whitespace 7 years ago
feature_mouse_keys.md Fixed dead links (#2451) 7 years ago
feature_pointing_device.md Fix some of the more obvious typos 7 years ago
feature_ps2_mouse.md Trim trailing whitespace 7 years ago
feature_rgblight.md ADD RGBLIGHT_LIMIT_VAL (#2214) 7 years ago
feature_space_cadet.md Fix some of the more obvious typos 7 years ago
feature_space_shift_cadet.md new planck keymap, new feature - hybrid shift/enter action key (great for small keyboards!) (#2100) 7 years ago
feature_stenography.md Fix some of the more obvious typos 7 years ago
feature_tap_dance.md Trim trailing whitespace 7 years ago
feature_terminal.md Trim trailing whitespace 7 years ago
feature_thermal_printer.md Format keycode tables 7 years ago
feature_unicode.md Fix some of the more obvious typos 7 years ago
feature_userspace.md Trim trailing whitespace 7 years ago
features.md Fix some of the more obvious typos 7 years ago
flashing.md Trim trailing whitespace 7 years ago
fuse.txt convert docs to lowercase and underscores 8 years ago
getting_started_build_tools.md Fixed formatting for Fedora example 7 years ago
getting_started_github.md Convert all headings to Title Case 7 years ago
getting_started_introduction.md Convert all headings to Title Case 7 years ago
getting_started_make_guide.md Trim trailing whitespace 7 years ago
getting_started_vagrant.md Fix some of the more obvious typos 7 years ago
glossary.md Fixed dead links (#2451) 7 years ago
hand_wire.md Trim trailing whitespace 7 years ago
hardware.md Fix some of the more obvious typos 7 years ago
hardware_avr.md backlight breathing overhaul (#2187) 7 years ago
hardware_drivers.md Convert all headings to Title Case 7 years ago
hardware_keyboard_guidelines.md Trim trailing whitespace 7 years ago
how_keyboards_work.md Convert all headings to Title Case 7 years ago
isp_flashing_guide.md Trim trailing whitespace 7 years ago
keycode.txt Trim trailing whitespace 7 years ago
keycodes.md Fixed typo of 'confid.h' to 'config.h' (#2448) 7 years ago
keycodes_basic.md Format keycode tables 7 years ago
keycodes_us_ansi_shifted.md Trim trailing whitespace 7 years ago
keymap.md Minor updates to docs (#2406) 7 years ago
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md Fix some of the more obvious typos 7 years ago
power.txt Trim trailing whitespace 7 years ago
quantum_keycodes.md Trim trailing whitespace 7 years ago
redirects.json Restructure the hardware and feature docs to make things easier to find (#1888) 7 years ago
understanding_qmk.md Fixed dead links (#2451) 7 years ago
unit_testing.md Trim trailing whitespace 7 years ago
usb_nkro.txt convert docs to lowercase and underscores 8 years ago

README.md

Quantum Mechanical Keyboard Firmware

What is QMK Firmware?

QMK (Quantum Mechanical Keyboard) is an open source community that maintains QMK Firmware, QMK Flasher, qmk.fm, and these docs. QMK Firmware is a keyboard firmware based on the tmk_keyboard with some useful features for Atmel AVR controllers, and more specifically, the OLKB product line, the ErgoDox EZ keyboard, and the Clueboard product line. It has also been ported to ARM chips using ChibiOS. You can use it to power your own hand-wired or custom keyboard PCB.

How to Get It

If you plan on contributing a keymap, keyboard, or features to QMK, the easiest thing to do is fork the repo through Github, and clone your repo locally to make your changes, push them, then open a Pull Request from your fork.

Otherwise, you can either download it directly (zip, tar), or clone it via git (git@github.com:qmk/qmk_firmware.git), or https (https://github.com/qmk/qmk_firmware.git).

How to Compile

Before you are able to compile, you'll need to install an environment for AVR or/and ARM development. Once that is complete, you'll use the make command to build a keyboard and keymap with the following notation:

make planck/rev4:default

This would build the rev4 revision of the planck with the default keymap. Not all keyboards have revisions (also called subprojects or folders), in which case, it can be omitted:

make preonic:default

How to Customize

QMK has lots of features to explore, and a good deal of reference documentation to dig through. Most features are taken advantage of by modifying your keymap, and changing the keycodes.