qmk_firmware/assets/porting_your_keyboard_to_qmk.md.GXDU4XR5.js

import { _ as _export_sfc, c as createElementBlock, o as openBlock, a8 as createStaticVNode } from "./chunks/framework.B9AX-CPi.js";
const __pageData = JSON.parse('{"title":"Adding Your Keyboard to QMK","description":"","frontmatter":{},"headers":[],"relativePath":"porting_your_keyboard_to_qmk.md","filePath":"porting_your_keyboard_to_qmk.md","lastUpdated":null}');
const _sfc_main = { name: "porting_your_keyboard_to_qmk.md" };
const _hoisted_1 = /* @__PURE__ */ createStaticVNode('<h1 id="adding-your-keyboard-to-qmk" tabindex="-1">Adding Your Keyboard to QMK <a class="header-anchor" href="#adding-your-keyboard-to-qmk" aria-label="Permalink to &quot;Adding Your Keyboard to QMK&quot;">​</a></h1><p>This page describes the support for <a href="./compatible_microcontrollers">Compatible Microcontrollers</a> in QMK.</p><p>If you have not yet you should read the <a href="./hardware_keyboard_guidelines">Keyboard Guidelines</a> to get a sense of how keyboards fit into QMK.</p><p>QMK has a number of features to simplify working with keyboards. For most, you don&#39;t have to write a single line of code. To get started, run <code>qmk new-keyboard</code>:</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span>$ qmk new-keyboard</span></span>\n<span class="line"><span>Ψ Generating a new QMK keyboard directory</span></span>\n<span class="line"><span></span></span>\n<span class="line"><span>Name Your Keyboard Project</span></span>\n<span class="line"><span>For more infomation, see:</span></span>\n<span class="line"><span>https://docs.qmk.fm/hardware_keyboard_guidelines#naming-your-keyboardproject</span></span>\n<span class="line"><span></span></span>\n<span class="line"><span>keyboard Name? mycoolkeeb</span></span>\n<span class="line"><span></span></span>\n<span class="line"><span>Attribution</span></span>\n<span class="line"><span>Used for maintainer, copyright, etc</span></span>\n<span class="line"><span></span></span>\n<span class="line"><span>Your GitHub Username?  [jsmith] </span></span>\n<span class="line"><span></span></span>\n<span class="line"><span>More Attribution</span></span>\n<span class="line"><span>Used for maintainer, copyright, etc</span></span>\n<span class="line"><span></span></span>\n<span class="line"><span>Your Real Name?  [John Smith] </span></span>\n<span class="line"><span></span></span>\n<span class="line"><span>Pick Base Layout</span></span>\n<span class="line"><span>As a starting point, one of the common layouts can be used to bootstrap the process</span></span>\n<span class="line"><span></span></span>\n<span class="line"><span>Default Layout? </span></span>\n<span class="line"><span>	1. 60_ansi</span></span>\n<span class="line"><span>...</span></span>\n<span class="line"><span>	50. tkl_iso</span></span>\n<span class="line"><span>	51. none of the above</span></span>\n<span class="line"><span>Please enter your choice:  [51] </span></span>\n<span class="line"><span></span></span>\n<span class="line"><span>What Powers Your Project</span></span>\n<span class="line"><span>For more infomation, see:</span></span>\n<span class="line"><span>https://docs.qmk.fm/#/compatible_microcontrollers</span></span>\n<span class="line"><span></span></span>\n<span class="line"><span>MCU? </span></span>\n<span class="line"><span>	1. atmega32u4</span></span>\n<span class="line"><span>...</span></span>\n<span class="line"><span>	22. STM32F303</span></span>\n<span class="line"><span>Please enter your choice:  [12]</span></span>\n<span class="line"><span>Ψ Created a new keyboard called mycoolkeeb.</span></span>\n<span class="line"><span>Ψ To start working on things, `cd` into keyboards/mycoolkeeb,</span></span>\n<span class="line"><span>Ψ or open the directory in your preferred text editor.</span></span>\n<span class="line"><span>Ψ And build with qmk compile -kb mycoolkeeb -km default.</span></span></code></pre></div><p>This will create all the files needed to support your new keyboard, and populate the settings with default values. Now you just need to customize it for your keyboard.</p><h2 id="readme-md" tabindex="-1"><code>readme.md</code> <a class="header-anchor" href="#readme-md" aria-label="Permalink to &quot;`readme.md`&quot;">​</a></h2><p>This is where you&#39;ll describe your keyboard. Please follow the <a href="./documentation_templates#keyboard-readmemd-template">Keyboard Readme Tem
const _hoisted_37 = [
  _hoisted_1
];
function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
  return openBlock(), createElementBlock("div", null, _hoisted_37);
}
const porting_your_keyboard_to_qmk = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]);
export {
  __pageData,
  porting_your_keyboard_to_qmk as default
};