mirror of
https://github.com/qmk/qmk_firmware.git
synced 2025-02-27 01:56:43 +00:00
16 lines
24 KiB
JavaScript
16 lines
24 KiB
JavaScript
|
import { _ as _export_sfc, c as createElementBlock, o as openBlock, a8 as createStaticVNode } from "./chunks/framework.DyMmIvSC.js";
|
|||
|
|
const __pageData = JSON.parse('{"title":"Setting up Visual Studio Code for QMK Development","description":"","frontmatter":{},"headers":[],"relativePath":"other_vscode.md","filePath":"other_vscode.md"}');
|
|||
|
|
const _sfc_main = { name: "other_vscode.md" };
|
|||
|
|
const _hoisted_1 = /* @__PURE__ */ createStaticVNode('<h1 id="setting-up-visual-studio-code-for-qmk-development" tabindex="-1">Setting up Visual Studio Code for QMK Development <a class="header-anchor" href="#setting-up-visual-studio-code-for-qmk-development" aria-label="Permalink to "Setting up Visual Studio Code for QMK Development""></a></h1><p><a href="https://code.visualstudio.com/" target="_blank" rel="noreferrer">Visual Studio Code</a> (VS Code) is an open-source code editor that supports many different programming languages.</p><p>Using a full-featured editor such as VS Code provides many advantages over a plain text editor, such as:</p><ul><li>intelligent code completion</li><li>convenient navigation in the code</li><li>refactoring tools</li><li>build automation (no need for the command-line)</li><li>a graphical front end for GIT</li><li>many other tools such as debugging, code formatting, showing call hierarchies etc.</li></ul><p>The purpose of this page is to document how to set up VS Code for developing QMK Firmware.</p><p>This guide covers how to configure everything needed on Windows and Ubuntu 18.04</p><h1 id="set-up-vs-code" tabindex="-1">Set up VS Code <a class="header-anchor" href="#set-up-vs-code" aria-label="Permalink to "Set up VS Code""></a></h1><p>Before starting, you will want to make sure that you have all of the build tools set up, and QMK Firmware cloned. Head to the <a href="./newbs_getting_started">Newbs Getting Started Guide</a> to get things set up, if you haven't already.</p><h2 id="windows" tabindex="-1">Windows <a class="header-anchor" href="#windows" aria-label="Permalink to "Windows""></a></h2><h3 id="prerequisites" tabindex="-1">Prerequisites <a class="header-anchor" href="#prerequisites" aria-label="Permalink to "Prerequisites""></a></h3><ul><li><p><a href="https://git-scm.com/download/win" target="_blank" rel="noreferrer">Git for Windows</a> (This link will prompt to save/run the installer)</p><ol><li>Disable all of the options but <code>Git LFS (Large File Support)</code> and <code>Check daily for Git for Windows updates</code>.</li><li>Set the default editor to <code>Use Visual Studio Code as Git's default editor</code></li><li>Select the <code>Use Git from Git Bash only</code> option, since that's the option that you should use here.</li><li>For the <code>Choosing HTTPS transport backend</code>, either option should be fine.</li><li>Select the <code>Checkout as-is, commit Unix-style line endings</code> option. QMK Firmware uses Unix style commits.</li><li>For the extra options, leave the default options as is.</li></ol><p>This software is needed for Git support in VS Code. It may be possible to not include this, but it is much simpler to just use this.</p></li><li><p><a href="https://github.com/Microsoft/Git-Credential-Manager-for-Windows/releases" target="_blank" rel="noreferrer">Git Credential Manager for Windows</a> (Optional)</p><p>This software provides better support for Git by providing secure storage for git credentials, MFA and personal access token generation.</p><p>This isn't strictly needed, but we would recommend it.</p></li></ul><h3 id="installing-vs-code" tabindex="-1">Installing VS Code <a class="header-anchor" href="#installing-vs-code" aria-label="Permalink to "Installing VS Code""></a></h3><ol><li>Head to <a href="https://code.visualstudio.com/" target="_blank" rel="noreferrer">VS Code</a> and download the installer</li><li>Run the installer</li></ol><p>This part is super simple. However, there is some configuration that we need to do to ensure things are configured correctly.</p><h4 id="msys2-setup" tabindex="-1">MSYS2 Setup <a class="header-anchor" href="#msys2-setup" aria-label="Permalink to "MSYS2 Setup""></a></h4><p>Now, we will set up the MSYS2 window to show up in VSCode as the integrated terminal. This has a number of advantages. Mostly, you can control+click on errors and jump to those files. This makes debugging much easier. It's also nice, in that you d
|
|||
|
|
const _hoisted_52 = [
|
|||
|
|
_hoisted_1
|
|||
|
|
];
|
|||
|
|
function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
|
|||
|
|
return openBlock(), createElementBlock("div", null, _hoisted_52);
|
|||
|
|
}
|
|||
|
|
const other_vscode = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]);
|
|||
|
|
export {
|
|||
|
|
__pageData,
|
|||
|
|
other_vscode as default
|
|||
|
|
};
|