qmk_firmware/assets/other_eclipse.md.CT58b2iV.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":"Setting up Eclipse for QMK Development","description":"","frontmatter":{},"headers":[],"relativePath":"other_eclipse.md","filePath":"other_eclipse.md"}');
const _sfc_main = { name: "other_eclipse.md" };
const _hoisted_1 = /* @__PURE__ */ createStaticVNode('<h1 id="setting-up-eclipse-for-qmk-development" tabindex="-1">Setting up Eclipse for QMK Development <a class="header-anchor" href="#setting-up-eclipse-for-qmk-development" aria-label="Permalink to &quot;Setting up Eclipse for QMK Development&quot;">​</a></h1><p><a href="https://en.wikipedia.org/wiki/Eclipse_(software)" target="_blank" rel="noreferrer">Eclipse</a> is an open-source <a href="https://en.wikipedia.org/wiki/Integrated_development_environment" target="_blank" rel="noreferrer">Integrated Development Environment</a> (IDE) widely used for Java development, but with an extensible plugin system that allows to customize it for other languages and usages.</p><p>Using an IDE such as Eclipse 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 GUI for GIT</li><li>static code analysis</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 Eclipse for developing AVR software, and working on the QMK code base.</p><p>Note that this set-up has been tested on Ubuntu 16.04 only for the moment.</p><h1 id="prerequisites" tabindex="-1">Prerequisites <a class="header-anchor" href="#prerequisites" aria-label="Permalink to &quot;Prerequisites&quot;">​</a></h1><h2 id="build-environment" tabindex="-1">Build Environment <a class="header-anchor" href="#build-environment" aria-label="Permalink to &quot;Build Environment&quot;">​</a></h2><p>Before starting, you must have followed the <a href="./newbs_getting_started">Getting Started</a> section of the Tutorial. In particular, you must have been able to build the firmware with <a href="./newbs_building_firmware#build-your-firmware">the <code>qmk compile</code> command</a>.</p><h2 id="java" tabindex="-1">Java <a class="header-anchor" href="#java" aria-label="Permalink to &quot;Java&quot;">​</a></h2><p>Eclipse is a Java application, so you will need to install Java 8 or more recent to be able to run it. You may choose between the JRE or the JDK, the latter being useful if you intend to do Java development.</p><h1 id="install-eclipse-and-its-plugins" tabindex="-1">Install Eclipse and Its Plugins <a class="header-anchor" href="#install-eclipse-and-its-plugins" aria-label="Permalink to &quot;Install Eclipse and Its Plugins&quot;">​</a></h1><p>Eclipse comes in <a href="https://www.eclipse.org/downloads/eclipse-packages/" target="_blank" rel="noreferrer">several flavours</a> depending on the target usage that you will have. There is no package comprising the AVR stack, so we will need to start from Eclipse CDT (C/C++ Development Tooling) and install the necessary plugins.</p><h2 id="download-and-install-eclipse-cdt" tabindex="-1">Download and Install Eclipse CDT <a class="header-anchor" href="#download-and-install-eclipse-cdt" aria-label="Permalink to &quot;Download and Install Eclipse CDT&quot;">​</a></h2><p>If you already have Eclipse CDT on your system, you can skip this step. However it is advised to keep it up-to-date for better support.</p><p>If you have another Eclipse package installed, it is normally possible to <a href="https://eclipse.org/cdt/downloads.php" target="_blank" rel="noreferrer">install the CDT plugin over it</a>. However it is probably better to reinstall it from scratch to keep it light and avoid the clutter of tools that you don&#39;t need for the projects you will be working on.</p><p>Installation is very simple: follow the <a href="https://eclipse.org/downloads/eclipse-packages/?show_instructions=TRUE" target="_blank" rel="noreferrer">5 Steps to Install Eclipse</a>, and choose <strong>Eclipse IDE for C/C++ Developers</strong> at Step 3.</p><p>Alternatively, you can also directly <a href="https://www.eclipse.org/downloads/eclipse-packages/" target="_blank" rel="noreferrer">download Eclipse IDE for C/C++ Developers</a> (<a href
const _hoisted_41 = [
  _hoisted_1
];
function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
  return openBlock(), createElementBlock("div", null, _hoisted_41);
}
const other_eclipse = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]);
export {
  __pageData,
  other_eclipse as default
};