qmk_firmware/getting_started_make_guide.html

25 lines
107 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>More Detailed make Instructions | QMK Firmware</title>
<meta name="description" content="Documentation for QMK Firmware">
<meta name="generator" content="VitePress v1.1.3">
<link rel="preload stylesheet" href="/assets/style.No8zk9aC.css" as="style">
<script type="module" src="/assets/app.G8yPgZjW.js"></script>
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/assets/chunks/theme.BXuOQ_O6.js">
<link rel="modulepreload" href="/assets/chunks/framework.Clpp4x2N.js">
<link rel="modulepreload" href="/assets/getting_started_make_guide.md.snyKLkVb.lean.js">
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
</head>
<body>
<div id="app"><div class="Layout" data-v-5d98c3a5><!--[--><!--]--><!--[--><span tabindex="-1" data-v-0f60ec36></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-0f60ec36> Skip to content </a><!--]--><!----><header class="VPNav" data-v-5d98c3a5 data-v-ae24b3ad><div class="VPNavBar has-sidebar top" data-v-ae24b3ad data-v-ccf7ddec><div class="wrapper" data-v-ccf7ddec><div class="container" data-v-ccf7ddec><div class="title" data-v-ccf7ddec><div class="VPNavBarTitle has-sidebar" data-v-ccf7ddec data-v-ab179fa1><a class="title" href="/" data-v-ab179fa1><!--[--><!--]--><!--[--><!--[--><!--[--><img class="VPImage dark logo" src="/qmk-logo-dark.svg" alt data-v-8426fc1a><!--]--><!--[--><img class="VPImage light logo" src="/qmk-logo-light.svg" alt data-v-8426fc1a><!--]--><!--]--><!--]--><span data-v-ab179fa1>QMK Firmware</span><!--[--><!--]--></a></div></div><div class="content" data-v-ccf7ddec><div class="content-body" data-v-ccf7ddec><!--[--><!--]--><div class="VPNavBarSearch search" data-v-ccf7ddec><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-ccf7ddec data-v-7f418b0f><span id="main-nav-aria-label" class="visually-hidden" data-v-7f418b0f>Main Navigation</span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/" tabindex="0" data-v-7f418b0f data-v-9c663999><!--[--><span data-v-9c663999>Home</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-ccf7ddec data-v-e6aabb21><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="Switch to dark theme" aria-checked="false" data-v-e6aabb21 data-v-d1f28634 data-v-1d5665e3><span class="check" data-v-1d5665e3><span class="icon" data-v-1d5665e3><!--[--><span class="vpi-sun sun" data-v-d1f28634></span><span class="vpi-moon moon" data-v-d1f28634></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-ccf7ddec data-v-0394ad82 data-v-7bc22406><!--[--><a class="VPSocialLink no-icon" href="https://reddit.com/r/olkb" aria-label target="_blank" rel="noopener" data-v-7bc22406 data-v-eee4e7cb><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 50 50" width="50px" height="50px"><path d="M 29 3 C 28.0625 3 27.164063 3.382813 26.5 4 C 25.835938 4.617188 25.363281 5.433594 25 6.40625 C 24.355469 8.140625 24.085938 10.394531 24.03125 13.03125 C 19.234375 13.179688 14.820313 14.421875 11.28125 16.46875 C 10.214844 15.46875 8.855469 14.96875 7.5 14.96875 C 6.089844 14.96875 4.675781 15.511719 3.59375 16.59375 C 1.425781 18.761719 1.425781 22.238281 3.59375 24.40625 L 3.84375 24.65625 C 3.3125 26.035156 3 27.488281 3 29 C 3 33.527344 5.566406 37.585938 9.5625 40.4375 C 13.558594 43.289063 19.007813 45 25 45 C 30.992188 45 36.441406 43.289063 40.4375 40.4375 C 44.433594 37.585938 47 33.527344 47 29 C 47 27.488281 46.6875 26.035156 46.15625 24.65625 L 46.40625 24.40625 C 48.574219 22.238281 48.574219 18.761719 46.40625 16.59375 C 45.324219 15.511719 43.910156 14.96875 42.5 14.96875 C 41.144531 14.96875 39.785156 15.46875 38.71875 16.46875 C 35.195313 14.433594 30.800781 13.191406 26.03125 13.03125 C 26.09375 10.546875 26.363281 8.46875 26.875 7.09375 C 27.164063 6.316406 27.527344 5.757813 27.875 5.4375 C 28.222656 5.117188 28.539063 5 29 5 C 29.460938 5 29.683594 5.125 30.03125 5.40625 C 30.378906 5.6875 30.785156 6.148438 31.3125 6.6875 C 32.253906 7.652344 33.695313 8.714844 36.09375 8.9375 C 36.539063 11.238281 38.574219 13 41 13 C 43.75 13 46 10.75 46 8 C 46 5.25 43.75 3 41 3 C 38.605469 3 36.574219 4.710938 36.09375 6.96875 C 34.3125 6.796875 33.527344 6.109375 32.75 5.3125 C 32.300781 4.851563 31.886719 4
</code></pre><p><code>MIDI_ENABLE</code></p><p>This enables MIDI sending and receiving with your keyboard. To enter MIDI send mode, you can use the keycode <code>MI_ON</code>, and <code>MI_OFF</code> to turn it off. This is a largely untested feature, but more information can be found in the <code>quantum/quantum.c</code> file.</p><p><code>UNICODE_ENABLE</code></p><p>This allows you to send Unicode characters using <code>UC(&lt;code point&gt;)</code> in your keymap. Code points up to <code>0x7FFF</code> are supported. This covers characters for most modern languages, as well as symbols, but it doesn&#39;t cover emoji.</p><p><code>UNICODEMAP_ENABLE</code></p><p>This allows you to send Unicode characters using <code>UM(&lt;map index&gt;)</code> in your keymap. You will need to maintain a mapping table in your keymap file. All possible code points (up to <code>0x10FFFF</code>) are supported.</p><p><code>UCIS_ENABLE</code></p><p>This allows you to send Unicode characters by inputting a mnemonic corresponding to the character you want to send. You will need to maintain a mapping table in your keymap file. All possible code points (up to <code>0x10FFFF</code>) are supported.</p><p>For further details, as well as limitations, see the <a href="./features/unicode">Unicode page</a>.</p><p><code>AUDIO_ENABLE</code></p><p>This allows you output audio on the C6 pin (needs abstracting). See the <a href="./features/audio">audio page</a> for more information.</p><p><code>VARIABLE_TRACE</code></p><p>Use this to debug changes to variable values, see the <a href="./unit_testing#tracing-variables">tracing variables</a> section of the Unit Testing page for more information.</p><p><code>KEY_LOCK_ENABLE</code></p><p>This enables <a href="./features/key_lock">key lock</a>.</p><p><code>SPLIT_KEYBOARD</code></p><p>This enables split keyboard support (dual MCU like the let&#39;s split and bakingpy&#39;s boards) and includes all necessary files located at quantum/split_common</p><p><code>SPLIT_TRANSPORT</code></p><p>As there is no standard split communication driver for ARM-based split keyboards yet, <code>SPLIT_TRANSPORT = custom</code> must be used for these. It will prevent the standard split keyboard communication code (which is AVR-specific) from being included, allowing a custom implementation to be used.</p><p><code>CUSTOM_MATRIX</code></p><p>Lets you replace the default matrix scanning routine with your own code. For further details, see the <a href="./custom_matrix">Custom Matrix page</a>.</p><p><code>DEBOUNCE_TYPE</code></p><p>Lets you replace the default key debouncing routine with an alternative one. If <code>custom</code> you will need to provide your own implementation.</p><p><code>DEFERRED_EXEC_ENABLE</code></p><p>Enables deferred executor support -- timed delays before callbacks are invoked. See <a href="./custom_quantum_functions#deferred-execution">deferred execution</a> for more information.</p><h2 id="customizing-makefile-options-on-a-per-keymap-basis" tabindex="-1">Customizing Makefile Options on a Per-Keymap Basis <a class="header-anchor" href="#customizing-makefile-options-on-a-per-keymap-basis" aria-label="Permalink to &quot;Customizing Makefile Options on a Per-Keymap Basis&quot;"></a></h2><p>If your keymap directory has a file called <code>rules.mk</code> any options you set in that file will take precedence over other <code>rules.mk</code> options for your particular keyboard.</p><p>So let&#39;s say your keyboard&#39;s <code>rules.mk</code> has <code>BACKLIGHT_ENABLE = yes</code>. You want your particular keyboard to not have the backlight, so you make a file called <code>rules.mk</code> and specify <code>BACKLIGHT_ENABLE = no</code>.</p></div></div></main><footer class="VPDocFooter" data-v-39a288b8 data-v-09de1c0f><!--[--><!--]--><!----><nav class="prev-next" data-v-09de1c0f><div class="pager" data-v-09de1c0f><a class="VPLink link pager-link prev" href="/data_driven_config" data-v-09de1c0f><!--[--><span class="desc" data-v-09de1c0f>Previous page</span><span class="title" data-v-09de1c0f>Data Driven Configuration</spa
<script>window.__VP_HASH_MAP__=JSON.parse("{\"changelog_20190830.md\":\"Bivr4BOW\",\"changelog_20200229.md\":\"BlwjdGdl\",\"changelog_20201128.md\":\"Bv3MtRZN\",\"changelog_20210227.md\":\"BZCS3QyX\",\"changelog_20211127.md\":\"Dnz3u-H6\",\"changelog_20210529.md\":\"BuRukn9m\",\"changelog_20221126.md\":\"CSlb6-9w\",\"changelog_20200829.md\":\"Dkrt3arz\",\"changelog_20230226.md\":\"BhryCt4E\",\"changelog_20220827.md\":\"CV9uGcQ3\",\"changelog_20200530.md\":\"JEJG56LT\",\"changelog_20220226.md\":\"DnHKntZW\",\"changelog_20240825.md\":\"B1yD6-2m\",\"changelog_20210828.md\":\"BZyVeEhg\",\"changelog_20231126.md\":\"CTAqtmrE\",\"changelog_20240526.md\":\"CmS3Cuz0\",\"changelog_20220528.md\":\"l98aHfdl\",\"capabilities.md\":\"BPL75VHK\",\"capabilities_inc.md\":\"IeyuI9Wf\",\"changelog_20230827.md\":\"hs0Cz5za\",\"changelog_20230528.md\":\"BJIkUgVm\",\"api_development_environment.md\":\"BdPW5Xxm\",\"api_development_overview.md\":\"BZJTSE_s\",\"api_overview.md\":\"BzzvVapY\",\"changelog_20240225.md\":\"DI6ZhnH_\",\"api_docs.md\":\"DUul50UI\",\"arm_debugging.md\":\"DVeULkLA\",\"breaking_changes.md\":\"DWuHNvRs\",\"drivers_is31fl3742a.md\":\"Cjvb_b-G\",\"features_auto_shift.md\":\"jwKJBlE4\",\"configurator_architecture.md\":\"CmFDpVLe\",\"features_wpm.md\":\"ClHUqqGQ\",\"breaking_changes_history.md\":\"Bkin0Zmd\",\"drivers_is31fl3746a.md\":\"BGP2PAJT\",\"compatible_microcontrollers.md\":\"BgEcnKTp\",\"feature_layouts.md\":\"Cjp6pYRh\",\"isp_flashing_guide.md\":\"BCLez560\",\"feature_userspace.md\":\"BWBTJPLX\",\"other_vscode.md\":\"BDsv-WIr\",\"features_split_keyboard.md\":\"CNVf0IPB\",\"newbs_flashing.md\":\"BxrsbpFT\",\"newbs_getting_started.md\":\"CpbFaJqI\",\"newbs_git_best_practices.md\":\"BQEFeFMK\",\"newbs_git_resolving_merge_conflicts.md\":\"CbGBcgDe\",\"newbs_git_resynchronize_a_branch.md\":\"DK2XHvqc\",\"features_audio.md\":\"Dy0ToeLW\",\"hardware_keyboard_guidelines.md\":\"M0UlpwHv\",\"features_send_string.md\":\"CgbdP6B4\",\"custom_quantum_functions.md\":\"DtIuNxTQ\",\"documentation_best_practices.md\":\"CsnEVROI\",\"data_driven_config.md\":\"3iL4-P4O\",\"documentation_templates.md\":\"Bzrbq1wQ\",\"drivers_i2c.md\":\"Dr29Qpwd\",\"drivers_is31fl3218.md\":\"CbXgZf0f\",\"features_autocorrect.md\":\"CrKw5pKP\",\"drivers_is31fl3729.md\":\"D51u1Zj1\",\"drivers_apa102.md\":\"DRKqdW0M\",\"drivers_is31fl3733.md\":\"DkzQC1rk\",\"driver_installation_zadig.md\":\"Dy2kYHSK\",\"feature_advanced_keycodes.md\":\"BI-acvLB\",\"feature_eeprom.md\":\"tGEc5qB_\",\"cli_tab_complete.md\":\"NVbK-H31\",\"feature_debounce_type.md\":\"DBjOROev\",\"faq_misc.md\":\"CrAryH8S\",\"drivers_adc.md\":\"B7GhN9cb\",\"feature_layers.md\":\"CTvZ1vMr\",\"drivers_is31fl3731.md\":\"BAADR_YT\",\"drivers_is31fl3736.md\":\"D-ShjYav\",\"cli_development.md\":\"DHT__02d\",\"drivers_is31fl3737.md\":\"BqpmIJMQ\",\"drivers_serial.md\":\"CDjOJdNt\",\"drivers_is31fl3745.md\":\"D5R_sxfC\",\"cli.md\":\"BmxhRPcP\",\"features_bootmagic.md\":\"DIHkTTz1\",\"features_caps_word.md\":\"C0fpUfY4\",\"features_bluetooth.md\":\"Bs2LdUw_\",\"faq_build.md\":\"DgVYb8Zh\",\"features_command.md\":\"B4mE21dh\",\"drivers_is31fl3236.md\":\"DB6z91iZ\",\"drivers_spi.md\":\"DoCZg1iV\",\"features_digitizer.md\":\"DBSZvpwE\",\"contributing.md\":\"C-zh8zuX\",\"features_combo.md\":\"CC9QZAP7\",\"features_dynamic_macros.md\":\"ZTtIhM8T\",\"easy_maker.md\":\"CW6jlMO-\",\"configurator_troubleshooting.md\":\"DRmoLxtC\",\"cli_configuration.md\":\"CY0YDFkc\",\"features_grave_esc.md\":\"DTvs6396\",\"faq_debug.md\":\"BDXERRoT\",\"features_haptic_feedback.md\":\"DVUdhF3q\",\"features_hd44780.md\":\"kUIf1-0D\",\"drivers_gpio.md\":\"C81HQm2y\",\"drivers_is31fl3741.md\":\"9e7jzvwW\",\"faq_general.md\":\"BRXTvqDs\",\"custom_matrix.md\":\"BaJLCNe_\",\"newbs_building_firmware_workflow.md\":\"CiP7v8Cc\",\"newbs_building_firmware_configurator.md\":\"BwSLgipx\",\"keycodes_basic.md\":\"B_iSDgm4\",\"keycodes_us_ansi_shifted.md\":\"72mjMG-4\",\"keycodes_magic.md\":\"LOQRAy94\",\"newbs_building_firmware.md\":\"CybovRdt\",\"keymap.md\":\"C4xC8DKs\",\"features_stenography.md\":\"BmdUwUEg\",\"mod_tap.md\":\"B5t5NSBO\",
</body>
</html>