2024-09-18 08:58:07 +00:00
|
|
|
|
import { _ as _export_sfc, c as createElementBlock, o as openBlock, a8 as createStaticVNode } from "./chunks/framework.Clpp4x2N.js";
|
2024-05-30 02:02:10 +00:00
|
|
|
|
const __pageData = JSON.parse('{"title":"Frequently Asked Questions","description":"","frontmatter":{},"headers":[],"relativePath":"faq_general.md","filePath":"faq_general.md"}');
|
|
|
|
|
|
const _sfc_main = { name: "faq_general.md" };
|
2024-08-15 13:38:41 +00:00
|
|
|
|
const _hoisted_1 = /* @__PURE__ */ createStaticVNode('<h1 id="frequently-asked-questions" tabindex="-1">Frequently Asked Questions <a class="header-anchor" href="#frequently-asked-questions" aria-label="Permalink to "Frequently Asked Questions""></a></h1><h2 id="what-is-qmk" tabindex="-1">What is QMK? <a class="header-anchor" href="#what-is-qmk" aria-label="Permalink to "What is QMK?""></a></h2><p><a href="https://github.com/qmk" target="_blank" rel="noreferrer">QMK</a>, short for Quantum Mechanical Keyboard, is a group of people building tools for custom keyboards. We started with the <a href="https://github.com/qmk/qmk_firmware" target="_blank" rel="noreferrer">QMK firmware</a>, a heavily modified fork of <a href="https://github.com/tmk/tmk_keyboard" target="_blank" rel="noreferrer">TMK</a>.</p><h2 id="i-don-t-know-where-to-start" tabindex="-1">I don't know where to start! <a class="header-anchor" href="#i-don-t-know-where-to-start" aria-label="Permalink to "I don't know where to start!""></a></h2><p>If this is the case, then you should start with our <a href="./newbs">Newbs Guide</a>. There is a lot of great info there, and that should cover everything you need to get started.</p><p>If that's an issue, hop onto the <a href="https://config.qmk.fm" target="_blank" rel="noreferrer">QMK Configurator</a>, as that will handle a majority of what you need there.</p><h2 id="how-can-i-flash-the-firmware-i-built" tabindex="-1">How can I flash the firmware I built? <a class="header-anchor" href="#how-can-i-flash-the-firmware-i-built" aria-label="Permalink to "How can I flash the firmware I built?""></a></h2><p>First, head to the <a href="./faq_build">Compiling/Flashing FAQ Page</a>. There is a good deal of info there, and you'll find a bunch of solutions to common issues there.</p><h2 id="what-if-i-have-an-issue-that-isn-t-covered-here" tabindex="-1">What if I have an issue that isn't covered here? <a class="header-anchor" href="#what-if-i-have-an-issue-that-isn-t-covered-here" aria-label="Permalink to "What if I have an issue that isn't covered here?""></a></h2><p>Okay, that's fine. Then please check the <a href="https://github.com/qmk/qmk_firmware/issues" target="_blank" rel="noreferrer">open issues in our GitHub</a> to see if somebody is experiencing the same thing (make sure it's not just similar, but actually the same).</p><p>If you can't find anything, then please open a <a href="https://github.com/qmk/qmk_firmware/issues/new" target="_blank" rel="noreferrer">new issue</a>!</p><h2 id="what-if-i-found-a-bug" tabindex="-1">What if I found a bug? <a class="header-anchor" href="#what-if-i-found-a-bug" aria-label="Permalink to "What if I found a bug?""></a></h2><p>Then please open an <a href="https://github.com/qmk/qmk_firmware/issues/new" target="_blank" rel="noreferrer">issue</a>, and if you know how to fix it, open up a Pull Request on GitHub with the fix.</p><h2 id="but-git-and-github-are-intimidating" tabindex="-1">But <code>git</code> and <code>GitHub</code> are intimidating! <a class="header-anchor" href="#but-git-and-github-are-intimidating" aria-label="Permalink to "But `git` and `GitHub` are intimidating!""></a></h2><p>Don't worry, we have some pretty nice <a href="./newbs_git_best_practices">Guidelines</a> on how to start using <code>git</code> and GitHub to make things easier to develop.</p><p>Additionally, you can find additional <code>git</code> and GitHub related links <a href="./newbs_learn_more_resources">here</a>.</p><h2 id="i-have-a-keyboard-that-i-want-to-add-support-for" tabindex="-1">I have a Keyboard that I want to add support for <a class="header-anchor" href="#i-have-a-keyboard-that-i-want-to-add-support-for" aria-label="Permalink to "I have a Keyboard that I want to add support for""></a></h2><p>Awesome! Open up a Pull Request for it. We'll review the code, and merge it!</p><h3 id="what-if-i-want-to-brand-it-with-qmk" tabindex="-1">What if I want to brand i
|
2024-05-30 02:02:10 +00:00
|
|
|
|
const _hoisted_28 = [
|
|
|
|
|
|
_hoisted_1
|
|
|
|
|
|
];
|
|
|
|
|
|
function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
|
|
|
|
|
|
return openBlock(), createElementBlock("div", null, _hoisted_28);
|
|
|
|
|
|
}
|
|
|
|
|
|
const faq_general = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]);
|
|
|
|
|
|
export {
|
|
|
|
|
|
__pageData,
|
|
|
|
|
|
faq_general as default
|
|
|
|
|
|
};
|
