qmk_firmware/docs
Drashna Jaelre f5ae3760c6 Add send_unicode_hex_string function (#3828)
* Add send_string_unicode function

Co-authored-by: kdb424 <kdb424@gmail.com>
Co-authored-by: Konstantin <vomindoraan@gmail.com>

* Clean up code based on feedback

* Fix includes
2018-10-01 20:56:04 -04:00
..
gitbook/images
.nojekyll
CNAME
README.md
_sidebar.md Helpful functions 2018-08-26 07:32:15 -07:00
_summary.md Helpful functions 2018-08-26 07:32:15 -07:00
becoming_a_qmk_collaborator.md Tweak the wording in "Becoming a QMK Collaborator" 2018-08-30 07:39:58 -04:00
compatible_microcontrollers.md
config_options.md Make `PREVENT_STUCK_MODIFIERS` the default (#3107) 2018-09-17 13:48:02 -04:00
contributing.md docs/contributing: add `#pragma once` to Coding Conventions 2018-09-15 09:37:06 -07:00
custom_quantum_functions.md Add Function level EECONFIG code for EEPROM (#3084) 2018-10-01 20:53:14 -04:00
documentation_best_practices.md
documentation_templates.md Update Document Templates to reflect newer wording and URLs (#4006) 2018-09-28 12:04:30 -04:00
eclipse.md
faq.md
faq_build.md
faq_debug.md
faq_general.md
faq_keymap.md
feature_advanced_keycodes.md Docs: Tabulate Modifier & Mod-Tap keycode listings in advanced keycodes docs (#3799) 2018-08-30 09:37:05 -07:00
feature_audio.md Add On/Off keycodes 2018-09-25 13:28:36 -07:00
feature_auto_shift.md
feature_backlight.md Helpful functions 2018-08-26 07:32:15 -07:00
feature_bluetooth.md
feature_bootmagic.md Create AG_TOGG code to toggle Alt/Gui swap. 2018-09-17 15:04:22 -07:00
feature_command.md
feature_dynamic_macros.md
feature_grave_esc.md
feature_hd44780.md
feature_key_lock.md
feature_layouts.md Docs: Add docs for the `LAYOUT_*` macro to layouts (#3772) 2018-08-28 17:35:24 -07:00
feature_leader_key.md Fix LEADER_KEY docs. 2018-09-17 14:38:06 -07:00
feature_macros.md Add tap_code function (#3784) 2018-10-01 20:53:47 -04:00
feature_mouse_keys.md
feature_pointing_device.md
feature_ps2_mouse.md Circuitry sample for PS/2 Mouse (#3959) 2018-09-23 13:49:17 -07:00
feature_rgb_matrix.md Make digital rain RGB matrix effect #define configurable. 2018-10-01 12:54:37 -04:00
feature_rgblight.md rgblight.[ch] more configurable (#3582) 2018-09-13 10:24:09 -07:00
feature_space_cadet_shift.md
feature_space_cadet_shift_enter.md
feature_stenography.md
feature_swap_hands.md
feature_tap_dance.md
feature_terminal.md
feature_thermal_printer.md
feature_unicode.md Add send_unicode_hex_string function (#3828) 2018-10-01 20:56:04 -04:00
feature_userspace.md Spell-check update for Userspace documentation 2018-09-28 14:39:52 -04:00
features.md
flashing.md Correct small typo 2018-10-01 12:42:05 -04:00
fuse.txt
getting_started_build_tools.md
getting_started_getting_help.md
getting_started_github.md
getting_started_introduction.md
getting_started_make_guide.md
getting_started_vagrant.md
hand_wire.md
hardware.md
hardware_avr.md
hardware_drivers.md ISSI31FL3733 driver (#3679) 2018-08-28 09:03:11 -04:00
hardware_keyboard_guidelines.md
how_keyboards_work.md
index.html
internals_defines.md
internals_gpio_control.md Update quantum matrix to support both AVR and Chibios ARM (#3968) 2018-09-28 12:33:11 -04:00
internals_input_callback_reg.md
internals_midi_device.md
internals_midi_device_setup_process.md
internals_midi_util.md
internals_send_functions.md
internals_sysex_tools.md
isp_flashing_guide.md
keycode.txt
keycodes.md Create AG_TOGG code to toggle Alt/Gui swap. 2018-09-17 15:04:22 -07:00
keycodes_basic.md
keycodes_us_ansi_shifted.md
keymap.md Remove redefinition of `_______` in documentation example (#3924) 2018-09-19 16:18:15 -07:00
newbs.md
newbs_building_firmware.md Add an easy way to create new keymaps for your favorite keyboard (#3868) 2018-09-13 11:22:05 -07:00
newbs_flashing.md
newbs_getting_started.md
newbs_learn_more_resources.md
newbs_testing_debugging.md
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md
power.txt
qmk.css
quantum_keycodes.md
redirects.json
ref_functions.md Helpful functions 2018-08-26 07:32:15 -07:00
reference_glossary.md
sidebar.css
sw.js
understanding_qmk.md Make `PREVENT_STUCK_MODIFIERS` the default (#3107) 2018-09-17 13:48:02 -04:00
unit_testing.md
usb_nkro.txt

README.md

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

What is QMK Firmware?

QMK (Quantum Mechanical Keyboard) is an open source community that maintains QMK Firmware, QMK Toolbox, 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.