forked from qmk/qmk_firmware
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of https://github.com/qmk/qmk_firmware
- Loading branch information
Showing
15 changed files
with
1,124 additions
and
98 deletions.
There are no files selected for viewing
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,32 @@ | ||
| # Quantum Mechanical Keyboard Firmware | ||
|
|
||
| ## What is QMK Firmware? {#what-is-qmk-firmware} | ||
| [](https://github.com/qmk/qmk_firmware/tags) | ||
| [](https://travis-ci.org/qmk/qmk_firmware) | ||
| [](https://discord.gg/Uq7gcHh) | ||
| [](https://docs.qmk.fm) | ||
| [](https://github.com/qmk/qmk_firmware/pulse/monthly) | ||
| [](https://github.com/qmk/qmk_firmware/) | ||
|
|
||
| ## What is QMK Firmware? | ||
|
|
||
| QMK (*Quantum Mechanical Keyboard*) is an open source community that maintains QMK Firmware, QMK Flasher, qmk.fm, and these docs. QMK Firmware is a keyboard firmware based on the [tmk\_keyboard](http://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR controllers, and more specifically, the [OLKB product line](http://olkb.com), the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co/). It has also been ported to ARM chips using ChibiOS. You can use it to power your own hand-wired or custom keyboard PCB. | ||
|
|
||
| ## How to Get It {#how-to-get-it} | ||
| ## How to Get It | ||
|
|
||
| If you plan on contributing a keymap, keyboard, or features to QMK, the easiest thing to do is [fork the repo through Github](https://github.com/qmk/qmk_firmware#fork-destination-box), and clone your repo locally to make your changes, push them, then open a [Pull Request](https://github.com/qmk/qmk_firmware/pulls) from your fork. | ||
|
|
||
| Otherwise, you can either download it directly ([zip](https://github.com/qmk/qmk_firmware/zipball/master), [tar](https://github.com/qmk/qmk_firmware/tarball/master)), or clone it via git (`[email protected]:qmk/qmk_firmware.git`), or https (`https://github.com/qmk/qmk_firmware.git`). | ||
|
|
||
| ## How to Compile {#how-to-compile} | ||
| ## How to Compile | ||
|
|
||
| Before you are able to compile, you'll need to [install an environment](getting_started_build_tools.md) for AVR or/and ARM development. Once that is complete, you'll use the `make` command to build a keyboard and keymap with the following notation: | ||
| Before you are able to compile, you'll need to [install an environment](01_Getting_Started/01_Install_Build_Tools.md) for AVR or/and ARM development. Once that is complete, you'll use the `make` command to build a keyboard and keymap with the following notation: | ||
|
|
||
| make planck/rev4:default | ||
|
|
||
| This would build the `rev4` revision of the `planck` with the `default` keymap. Not all keyboards have revisions (also called subprojects or folders), in which case, it can be omitted: | ||
|
|
||
| make preonic:default | ||
|
|
||
| ## How to Customize {#how-to-customize} | ||
| ## How to Customize | ||
|
|
||
| QMK has lots of [features](features.md) to explore, and a good deal of [reference documentation](http://docs.qmk.fm) to dig through. Most features are taken advantage of by modifying your [keymap](keymap.md), and changing the [keycodes](keycodes.md). | ||
| QMK has lots of [features](05_Features/index.md) to explore, and a good deal of [reference documentation](http://docs.qmk.fm) to dig through. Most features are taken advantage of by modifying your [keymap](07_Reference/Keymap_Overview.md), and changing the [keycodes](06_Keycodes/index.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| * [Getting Started](README.md) | ||
| * [QMK Introduction](getting_started_introduction.md) | ||
| * [Install Build Tools](getting_started_build_tools.md) | ||
| * Alternative: [Vagrant Guide](getting_started_vagrant.md) | ||
| * [Build/Compile Instructions](getting_started_make_guide.md) | ||
| * [Flashing Firmware](flashing.md) | ||
| * [Contributing to QMK](contributing.md) | ||
| * [How to Use Github](getting_started_github.md) | ||
| * [Getting Help](getting_started_getting_help.md) | ||
|
|
||
| * [Complete Newbs Guide](newbs.md) | ||
| * [Getting Started](newbs_getting_started.md) | ||
| * [Building Your First Firmware](newbs_building_firmware.md) | ||
| * [Flashing Firmware](newbs_flashing.md) | ||
| * [Testing and Debugging](newbs_testing_debugging.md) | ||
|
|
||
| * [FAQ](faq.md) | ||
| * [General FAQ](faq_general.md) | ||
| * [Build/Compile QMK](faq_build.md) | ||
| * [Debugging/Troubleshooting QMK](faq_debug.md) | ||
| * [Keymap](faq_keymap.md) | ||
|
|
||
| * [Hardware](hardware.md) | ||
| * [Keyboard Guidelines](hardware_keyboard_guidelines.md) | ||
| * [AVR Processors](hardware_avr.md) | ||
| * ARM Processors (TBD) | ||
| * [Drivers](hardware_drivers.md) | ||
|
|
||
| * [Features](features.md) | ||
| * [Advanced Keycodes](feature_advanced_keycodes.md) | ||
| * [Audio](feature_audio.md) | ||
| * [Auto Shift](feature_auto_shift.md) | ||
| * [Backlight](feature_backlight.md) | ||
| * [Bootmagic](feature_bootmagic.md) | ||
| * [Command](feature_command.md) | ||
| * [Dynamic Macros](feature_dynamic_macros.md) | ||
| * [Grave Escape](feature_grave_esc.md) | ||
| * [Key Lock](feature_key_lock.md) | ||
| * [Layouts](feature_layouts.md) | ||
| * [Leader Key](feature_leader_key.md) | ||
| * [Macros](feature_macros.md) | ||
| * [Mouse Keys](feature_mouse_keys.md) | ||
| * [Pointing Device](feature_pointing_device.md) | ||
| * [PS/2 Mouse](feature_ps2_mouse.md) | ||
| * [RGB Lighting](feature_rgblight.md) | ||
| * [Space Cadet Shift](feature_space_cadet.md) | ||
| * [Space Cadet Shift Enter](feature_space_shift_cadet.md) | ||
| * [Stenography](feature_stenography.md) | ||
| * [Swap Hands](feature_swap_hands.md) | ||
| * [Tap Dance](feature_tap_dance.md) | ||
| * [Terminal](feature_terminal.md) | ||
| * [Thermal Printer](feature_thermal_printer.md) | ||
| * [Unicode](feature_unicode.md) | ||
| * [Userspace](feature_userspace.md) | ||
|
|
||
| * [Keycodes](keycodes.md) | ||
| * [Backlight](feature_backlight.md#backlight-keycodes) | ||
| * [Basic](keycodes_basic.md) | ||
| * [Bluetooth](feature_bluetooth.md#bluetooth-keycodes) | ||
| * [Bootmagic](feature_bootmagic.md#bootmagic-keycodes) | ||
| * [Layer Switching](feature_advanced_keycodes.md#switching-and-toggling-layers) | ||
| * [Mod+Key](feature_advanced_keycodes.md#modifier-keys) | ||
| * [Mod Tap](feature_advanced_keycodes.md#mod-tap) | ||
| * [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys) | ||
| * [Quantum](quantum_keycodes.md) | ||
| * [RGB Light](feature_rgblight.md#rgblight-keycodes) | ||
| * [Shifted Keys](feature_advanced_keycodes.md#shifted-keycodes) | ||
| * [Stenography](feature_stenography.md#keycode-reference) | ||
| * [Thermal Printer](feature_thermal_printer.md#thermal-printer-keycodes) | ||
| * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md) | ||
|
|
||
| * Reference | ||
| * [Config Options](config_options.md) | ||
| * [Customizing Functionality](custom_quantum_functions.md) | ||
| * [Documentation Best Practices](documentation_best_practices.md) | ||
| * [Documentation Templates](documentation_templates.md) | ||
| * [Glossary](reference_glossary.md) | ||
| * [Keymap Overview](keymap.md) | ||
| * [Unit Testing](unit_testing.md) | ||
|
|
||
| * For Makers and Modders | ||
| * [Hand Wiring Guide](hand_wire.md) | ||
| * [ISP Flashing Guide](isp_flashing_guide.md) | ||
|
|
||
| * For a Deeper Understanding | ||
| * [How Keyboards Work](how_keyboards_work.md) | ||
| * [Understanding QMK](understanding_qmk.md) | ||
|
|
||
| * Other Topics | ||
| * [Using Eclipse with QMK](eclipse.md) | ||
|
|
||
| * QMK Internals (In Progress) | ||
| * [Defines](internals_defines.md) | ||
| * [Input Callback Reg](internals_input_callback_reg.md) | ||
| * [Midi Device](internals_midi_device.md) | ||
| * [Midi Device Setup Process](internals_midi_device_setup_process.md) | ||
| * [Midi Util](internals_midi_util.md) | ||
| * [Send Functions](internals_send_functions.md) | ||
| * [Sysex Tools](internals_sysex_tools.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <title>Document</title> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" /> | ||
| <meta name="description" content="Description"> | ||
| <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"> | ||
| <link rel="stylesheet" href="qmk.css"> | ||
| </head> | ||
| <body> | ||
| <div id="app"></div> | ||
| <script> | ||
| window.$docsify = { | ||
| name: 'QMK Firmware', | ||
| nameLink: 'https://qmk.fm/', | ||
| repo: 'qmk/qmk_firmware', | ||
| loadSidebar: true, | ||
| auto2top: true, | ||
| formatUpdated: '{YYYY}/{MM}/{DD} {HH}:{mm}', | ||
| } | ||
| </script> | ||
| <script src="//unpkg.com/docsify/lib/docsify.min.js"></script> | ||
| <script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script> | ||
| <script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script> | ||
| <script src="//unpkg.com/prismjs/components/prism-c.min.js"></script> | ||
| <script src="//unpkg.com/prismjs/components/prism-cpp.min.js"></script> | ||
| <script src="//unpkg.com/prismjs/components/prism-json.min.js"></script> | ||
| <script src="//unpkg.com/prismjs/components/prism-makefile.min.js"></script> | ||
| <script> | ||
| if (typeof navigator.serviceWorker !== 'undefined') { | ||
| navigator.serviceWorker.register('sw.js') | ||
| } | ||
| </script> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.