2018-05-06 19:34:47 +00:00
<!DOCTYPE html>
< html class = "no-js" lang = "en" >
< head >
< title > Complete Newbie's Guide - QMK Firmware< / title >
< meta name = "description" content = "Keyboard controller firmware for Atmel AVR and ARM USB families" >
< meta name = "author" content = "QMK Community" >
< meta charset = "UTF-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
2018-05-08 04:02:24 +00:00
< link rel = "icon" href = "../themes/daux/img/favicon-navy.png" type = "image/x-icon" >
2018-05-06 19:34:47 +00:00
<!-- Mobile -->
< meta name = "apple-mobile-web-app-capable" content = "yes" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
<!-- Font -->
<!-- CSS -->
2018-05-08 04:02:24 +00:00
< link href = '../themes/daux/css/theme-navy.min.css' rel = 'stylesheet' type = 'text/css' >
2018-05-06 19:34:47 +00:00
<!-- Tipue Search -->
< link href = "../tipuesearch/tipuesearch.css" rel = "stylesheet" >
<!-- [if lt IE 9]>
< script src = "../themes/daux/js/html5shiv-3.7.3.min.js" > < / script >
<![endif]-->
< / head >
< body class = " " >
< div class = "Columns content" >
< aside class = "Columns__left Collapsible" >
< button type = "button" class = "Button Collapsible__trigger" >
< span class = "Collapsible__trigger__bar" > < / span >
< span class = "Collapsible__trigger__bar" > < / span >
< span class = "Collapsible__trigger__bar" > < / span >
< / button >
< a class = "Brand" href = "../index.html" > QMK Firmware< / a >
< div class = "Search" >
< svg class = "Search__icon" xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 451 451" >
< path d = "M447.05 428l-109.6-109.6c29.4-33.8 47.2-77.9 47.2-126.1C384.65 86.2 298.35 0 192.35 0 86.25 0 .05 86.3.05 192.3s86.3 192.3 192.3 192.3c48.2 0 92.3-17.8 126.1-47.2L428.05 447c2.6 2.6 6.1 4 9.5 4s6.9-1.3 9.5-4c5.2-5.2 5.2-13.8 0-19zM26.95 192.3c0-91.2 74.2-165.3 165.3-165.3 91.2 0 165.3 74.2 165.3 165.3s-74.1 165.4-165.3 165.4c-91.1 0-165.3-74.2-165.3-165.4z" / >
< / svg >
< input type = "search" id = "tipue_search_input" class = "Search__field" placeholder = "Search..." autocomplete = "on"
results=25 autosave=text_search>
< / div >
< div class = "Collapsible__content" >
<!-- Navigation -->
2018-05-08 04:02:24 +00:00
< ul class = 'Nav' > < li class = 'Nav__item has-children' > < a href = "../Getting_Started/index.html" class = "folder" > < i class = "Nav__arrow" > < / i > Getting Started< / a > < ul class = 'Nav' > < li class = 'Nav__item has-children' > < a href = "../Getting_Started/Install_Build_Tools/index.html" class = "folder" > < i class = "Nav__arrow" > < / i > Install Build Tools< / a > < ul class = 'Nav' > < li class = 'Nav__item ' > < a href = "../Getting_Started/Install_Build_Tools/Vagrant.html" > Vagrant< / a > < / li > < / ul > < / li > < li class = 'Nav__item ' > < a href = "../Getting_Started/Build_Compile_Instructions.html" > Build Compile Instructions< / a > < / li > < li class = 'Nav__item ' > < a href = "../Getting_Started/Flashing_Firmware.html" > Flashing Firmware< / a > < / li > < li class = 'Nav__item ' > < a href = "../Getting_Started/Contributing.html" > Contributing< / a > < / li > < li class = 'Nav__item ' > < a href = "../Getting_Started/How_to_Use_GitHub.html" > How to Use GitHub< / a > < / li > < li class = 'Nav__item ' > < a href = "../Getting_Started/Getting_Help.html" > Getting Help< / a > < / li > < / ul > < / li > < li class = 'Nav__item Nav__item--open has-children' > < a href = "../Complete_Newbs_Guide/index.html" class = "folder" > < i class = "Nav__arrow" > < / i > Complete Newbs Guide< / a > < ul class = 'Nav' > < li class = 'Nav__item Nav__item--active' > < a href = "../Complete_Newbs_Guide/Complete_Newbie's_Guide.html" > Complete Newbie's Guide< / a > < / li > < li class = 'Nav__item ' > < a href = "../Complete_Newbs_Guide/Building_Your_First_Firmware.html" > Building Your First Firmware< / a > < / li > < li class = 'Nav__item ' > < a href = "../Complete_Newbs_Guide/Flashing_Firmware.html" > Flashing Firmware< / a > < / li > < li class = 'Nav__item ' > < a href = "../Complete_Newbs_Guide/Testing_and_Debugging.html" > Testing and Debugging< / a > < / li > < / ul > < / li > < li class = 'Nav__item has-children' > < a href = "../FAQ/index.html" class = "folder" > < i class = "Nav__arrow" > < / i > FAQ< / a > < ul class = 'Nav' > < li class = 'Nav__item ' > < a href = "../FAQ/General_FAQ.html" > General FAQ< / a > < / li > < li class = 'Nav__item ' > < a href = "../FAQ/Build_Compile_QMK.html" > Build Compile QMK< / a > < / li > < li class = 'Nav__item ' > < a href = "../FAQ/Debugging_and_Troubleshooting.html" > Debugging and Troubleshooting< / a > < / li > < li class = 'Nav__item ' > < a href = "../FAQ/Keymaps.html" > Keymaps< / a > < / li > < / ul > < / li > < li class = 'Nav__item has-children' > < a href = "../Hardware/index.html" class = "folder" > < i class = "Nav__arrow" > < / i > Hardware< / a > < ul class = 'Nav' > < li class = 'Nav__item ' > < a href = "../Hardware/AVR_Processors.html" > AVR Processors< / a > < / li > < li class = 'Nav__item ' > < a href = "../Hardware/Drivers.html" > Drivers< / a > < / li > < / ul > < / li > < li class = 'Nav__item has-children' > < a href = "../Features/index.html" class = "folder" > < i class = "Nav__arrow" > < / i > Features< / a > < ul class = 'Nav' > < li class = 'Nav__item ' > < a href = "../Features/Advanced_Keycodes.html" > Advanced Keycodes< / a > < / li > < li class = 'Nav__item ' > < a href = "../Features/Audio.html" > Audio< / a > < / li > < li class = 'Nav__item ' > < a href = "../Features/Auto_Shift.html" > Auto Shift< / a > < / li > < li class = 'Nav__item ' > < a href = "../Features/Backlight.html" > Backlight< / a > < / li > < li class = 'Nav__item ' > < a href = "../Features/Bluetooth.html" > Bluetooth< / a > < / li > < li class = 'Nav__item ' > < a href = "../Features/Bootmagic.html" > Bootmagic< / a > < / li > < li class = 'Nav__item ' > < a href = "../Features/Command.html" > Command< / a > < / li > < li class = 'Nav__item ' > < a href = "../Features/Dynamic_Macros.html" > Dynamic Macros< / a > < / li > < li class = 'Nav__item ' > < a href = "../Features/Grave_Escape.html" > Grave Escape< / a > < / li > < li class = 'Nav__item ' > < a href = "../Features/Key_Lock.html" > Key Lock< / a > < / li > < li class = 'Nav__item ' > < a href = "../Features/Layouts.html" > Layouts< / a > < / li > < li class = 'Nav__item ' > < a href = "../Features/Leader_Key.html" > Leader Key< / a > < / li > < li class = 'Nav__item ' > < a href = "../Features/Macros.html" > Macros< / a > < / li > < li class = 'Nav__item ' > < a href = "../Features/Mouse_Keys.html" > Mouse Keys< / a > < / li > < li class = 'Nav__item ' > < a href = "../Features/Pointing_Device.html" > Pointing Device< / a > < / li > < li class = 'Nav__item ' > < a href = "../Features/PS_2_Mouse.html" > PS 2 Mouse< / a > < / li > < li class = 'Nav__item ' > < a href = "../Features/RGB_Lighting.html" > RGB Lighting< / a > < / li > < li class = 'Nav__item ' > < a href = "../Features/Space_Cadet_Shift.html" > Space Cadet Shift< / a > < / li > < li class = 'Nav__item
2018-05-06 19:34:47 +00:00
< div class = "Links" >
2018-05-08 04:02:24 +00:00
< / div >
2018-05-06 19:34:47 +00:00
< / div >
< / aside >
< div class = "Columns__right Columns__right--full" >
< div class = "Columns__right__content" >
< div class = "doc_content" >
< article class = "Page" >
< div class = "Page__header" >
< h1 > < a href = "../Complete_Newbs_Guide/index.html" > Complete Newbs Guide< / a > < svg class = "Page__header--separator" xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 477.175 477.175" > < path d = "M360.73 229.075l-225.1-225.1c-5.3-5.3-13.8-5.3-19.1 0s-5.3 13.8 0 19.1l215.5 215.5-215.5 215.5c-5.3 5.3-5.3 13.8 0 19.1 2.6 2.6 6.1 4 9.5 4 3.4 0 6.9-1.3 9.5-4l225.1-225.1c5.3-5.2 5.3-13.8.1-19z" / > < / svg > < a href = "../Complete_Newbs_Guide/Complete_Newbie's_Guide.html" > Complete Newbie's Guide< / a > < / h1 >
2018-05-08 04:02:24 +00:00
< span class = "EditOn" >
< a href = "https://github.com/qmk/qmk_firmware/blob/master/docs/02_Complete_Newbs_Guide/00_Complete_Newbie's_Guide.md" target = "_blank" >
Edit on GitHub < / a >
< / span >
< / div >
2018-05-06 19:34:47 +00:00
< div class = "s-content" >
< ul class = "TableOfContents" >
< li >
< p > < a href = "#page_The-Compelete-Newbs-Guide-To-QMK" > The Compelete Newbs Guide To QMK< / a > < / p >
< ul class = "TableOfContents" >
< li >
< p > < a href = "#page_Overview" > Overview< / a > < / p >
< / li >
< / ul >
< / li >
< / ul >
< h1 id = "page_The-Compelete-Newbs-Guide-To-QMK" > The Compelete Newbs Guide To QMK< / h1 >
< p > QMK is a powerful Open Source firmware for your mechanical keyboard. You can use QMK to customize your keyboard in ways both simple and powerful. People of all skill levels, from complete newbie to master programmer, have successfully used QMK to customize their keyboard. This guide will help you do the same, no matter your skill level.< / p >
< p > Not sure if your keyboard can run QMK? If it's a mechanical keyboard you built yourself chances are good it can. We support a < a href = "http://qmk.fm/keyboards/" class = "Link--external" > large number of hobbyist boards< / a > , so even if your current keyboard can't run QMK you shouldn't have trouble finding one to suit your needs.< / p >
< h2 id = "page_Overview" > Overview< / h2 >
< p > There are 4 main sections to this guide:< / p >
< ul >
< li >
< a href = "index.html" > Getting Started< / a >
< / li >
< li >
< a href = "Building_Your_First_Firmware.html" > Building Your First Firmware< / a >
< / li >
< li >
< a href = "Flashing_Firmware.html" > Flashing Firmware< / a >
< / li >
< li >
< a href = "Testing_and_Debugging.html" > Testing and Debugging< / a >
< / li >
< / ul >
< p > This guide is focused on helping someone who has never compiled software before. It makes choices and recommendations based on that viewpoint. There are alternative methods for many of these procedures, and we support most of those alternatives. If you have any doubt about how to accomplish a task you can < a href = "../Getting_Started/Getting_Help.html" > ask us for guidance< / a > .< / p >
< / div >
< nav >
< ul class = "Pager" >
< li class = Pager--prev > < a href = "../Complete_Newbs_Guide/index.html" > Previous< / a > < / li > < li class = Pager--next > < a href = "../Complete_Newbs_Guide/Building_Your_First_Firmware.html" > Next< / a > < / li > < / ul >
< / nav >
< / article >
< / div >
< / div >
< / div >
< / div >
<!-- JS -->
< script src = "../themes/daux/js/jquery-1.11.3.min.js" > < / script > < script src = "../themes/daux/js/highlight.pack.js" > < / script > < script src = "../themes/daux/js/daux.js" > < / script >
<!-- Tipue Search -->
< script type = "text/javascript" src = "../tipuesearch/tipuesearch.js" > < / script >
< script >
window.onunload = function(){}; // force $(document).ready to be called on back/forward navigation in firefox
$(function() {
tipuesearch({
'base_url': '../'
});
});
< / script >
< / body >
< / html >
