qmk_firmware/assets/getting_started_make_guide.md.D4dxTsF3.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":"More Detailed make Instructions","description":"","frontmatter":{},"headers":[],"relativePath":"getting_started_make_guide.md","filePath":"getting_started_make_guide.md","lastUpdated":null}');
const _sfc_main = { name: "getting_started_make_guide.md" };
const _hoisted_1 = /* @__PURE__ */ createStaticVNode('<h1 id="more-detailed-make-instructions" tabindex="-1">More Detailed <code>make</code> Instructions <a class="header-anchor" href="#more-detailed-make-instructions" aria-label="Permalink to &quot;More Detailed `make` Instructions&quot;">​</a></h1><p>The full syntax of the <code>make</code> command is <code>&lt;keyboard_folder&gt;:&lt;keymap&gt;:&lt;target&gt;</code>, where:</p><ul><li><code>&lt;keyboard_folder&gt;</code> is the path of the keyboard, for example <code>planck</code><ul><li>Use <code>all</code> to compile all keyboards</li><li>Specify the path to compile a revision, for example <code>planck/rev4</code> or <code>planck/rev3</code></li><li>If the keyboard doesn&#39;t have any folders, it can be left out</li><li>To compile the default folder, you can leave it out</li></ul></li><li><code>&lt;keymap&gt;</code> is the name of the keymap, for example <code>algernon</code><ul><li>Use <code>all</code> to compile all keymaps</li></ul></li><li><code>&lt;target&gt;</code> will be explained in more detail below.</li></ul><p>The <code>&lt;target&gt;</code> means the following</p><ul><li>If no target is given, then it&#39;s the same as <code>all</code> below</li><li><code>all</code> compiles as many keyboard/revision/keymap combinations as specified. For example, <code>make planck/rev4:default</code> will generate a single .hex, while <code>make planck/rev4:all</code> will generate a hex for every keymap available to the planck.</li><li><code>flash</code>, <code>dfu</code>, <code>teensy</code>, <code>avrdude</code>, <code>dfu-util</code>, or <code>bootloadhid</code> compile and upload the firmware to the keyboard. If the compilation fails, then nothing will be uploaded. The programmer to use depends on the keyboard. For most keyboards it&#39;s <code>dfu</code>, but for ChibiOS keyboards you should use <code>dfu-util</code>, and <code>teensy</code> for standard Teensys. To find out which command you should use for your keyboard, check the keyboard specific readme. Visit the <a href="./flashing">Flashing Firmware</a> guide for more details of the available bootloaders. <ul><li><strong>Note</strong>: some operating systems need privileged access for these commands to work. This means that you may need to setup <a href="./faq_build#linux-udev-rules"><code>udev rules</code></a> to access these without root access, or to run the command with root access (<code>sudo make planck/rev4:default:flash</code>).</li></ul></li><li><code>clean</code>, cleans the build output folders to make sure that everything is built from scratch. Run this before normal compilation if you have some unexplainable problems.</li><li><code>distclean</code> removes .hex files and .bin files.</li></ul><p>The following targets are for developers:</p><ul><li><code>show_path</code> shows the path of the source and object files.</li><li><code>dump_vars</code> dumps the makefile variable.</li><li><code>objs-size</code> displays the size of individual object files.</li><li><code>show_build_options</code> shows the options set in &#39;rules.mk&#39;.</li><li><code>check-md5</code> displays the md5 checksum of the generated binary file.</li></ul><p>You can also add extra options at the end of the make command line, after the target</p><ul><li><code>make COLOR=false</code> - turns off color output</li><li><code>make SILENT=true</code> - turns off output besides errors/warnings</li><li><code>make VERBOSE=true</code> - outputs all of the gcc stuff (not interesting, unless you need to debug)</li><li><code>make VERBOSE_LD_CMD=yes</code> - execute the ld command with the -v option.</li><li><code>make VERBOSE_AS_CMD=yes</code> - execute the as command with the -v option.</li><li><code>make VERBOSE_C_CMD=&lt;c_source_file&gt;</code> - add the -v option when compiling the specified C source file.</li><li><code>make DUMP_C_MACROS=&lt;c_source_file&gt;</code> - dump preprocessor macros when compiling the specified C source file.</li><li><code>make DUMP_C_MACROS=&lt;c_source_file&gt; &gt; &lt;logfile&gt;</code> - dump pre
const _hoisted_66 = [
  _hoisted_1
];
function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
  return openBlock(), createElementBlock("div", null, _hoisted_66);
}
const getting_started_make_guide = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]);
export {
  __pageData,
  getting_started_make_guide as default
};