aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorskullY <skullydazed@gmail.com>2020-02-20 11:57:43 -0800
committerskullydazed <skullydazed@users.noreply.github.com>2020-03-05 16:00:10 -0800
commit5b144560827d01b87e11be0e4539b35edca964ef (patch)
tree821081df80bd5bfc5ce215af144223a16e235f74
parentd1c18086d23c1f510ee434e1aa12b203f36e4794 (diff)
downloadqmk_firmware-5b144560827d01b87e11be0e4539b35edca964ef.tar.gz
qmk_firmware-5b144560827d01b87e11be0e4539b35edca964ef.zip
more wip
Diffstat
-rw-r--r--docs/_summary.md220
-rw-r--r--docs/faq.md6
-rw-r--r--docs/newbs_getting_started.md4
3 files changed, 116 insertions, 114 deletions
diff --git a/docs/_summary.md b/docs/_summary.md
index 66465667a..5edf61f6f 100644
--- a/docs/_summary.md
+++ b/docs/_summary.md
@@ -1,125 +1,133 @@
1* [Complete Newbs Guide](newbs.md) 1* Complete Newbs Guide
2 * [Introduction](newbs_getting_started.md) 2 * [Introduction](newbs.md)
3 * [Getting Started](newbs_getting_started.md)
3 * [Building Your First Firmware](newbs_building_firmware.md) 4 * [Building Your First Firmware](newbs_building_firmware.md)
4 * [Flashing Firmware](newbs_flashing.md) 5 * [Flashing Firmware](newbs_flashing.md)
5 * [Testing and Debugging](newbs_testing_debugging.md) 6 * [Testing and Debugging](newbs_testing_debugging.md)
6 * [Getting Help](getting_started_getting_help.md) 7 * [Getting Help](getting_started_getting_help.md)
7 8
8* Guides 9* Breaking Changes
9 * [ARM Debugging Guide](arm_debugging.md) 10 * [Overview](breaking_changes.md)
10 * [Best Git Practices](newbs_git_best_practices.md)
11 * [Contributing to QMK](contributing.md)
12 * [Customizing Functionality](custom_quantum_functions.md)
13 * [Github Best Practices](getting_started_github.md)
14 * [Hand Wiring Guide](hand_wire.md)
15 * [ISP Flashing Guide](isp_flashing_guide.md)
16 * [Flashing Firmware](flashing.md)
17 * [Keymap Overview](keymap.md)
18 * [Learning Resources](newbs_learn_more_resources.md)
19 * [QMK CLI](cli.md)
20 * [Vagrant Guide](getting_started_vagrant.md)
21
22* [Breaking Changes](breaking_changes.md)
23 * [My Pull Request Was Flagged](breaking_changes_instructions.md) 11 * [My Pull Request Was Flagged](breaking_changes_instructions.md)
24 * [2019 Aug 30](ChangeLog/20190830.md) 12 * History
13 * [2019 Aug 30](ChangeLog/20190830.md)
25 14
26* [FAQ](faq.md) 15* FAQs
27 * [General FAQ](faq_general.md) 16 * [General FAQ](faq_general.md)
28 * [Build/Compile QMK](faq_build.md) 17 * [Build/Compile QMK](faq_build.md)
29 * [Debugging/Troubleshooting QMK](faq_debug.md) 18 * [Debugging/Troubleshooting QMK](faq_debug.md)
30 * [Keymap](faq_keymap.md) 19 * [Keymap](faq_keymap.md)
31 * [Driver Installation with Zadig](driver_installation_zadig.md) 20 * [Driver Installation with Zadig](driver_installation_zadig.md)
32 21
33* QMK Features 22* Using QMK
34 * [Keycodes](keycodes.md) 23 * [Support](support.md)
35 * [Basic Keycodes](keycodes_basic.md) 24 * Guides
36 * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md) 25 * [ARM Debugging Guide](arm_debugging.md)
37 * [Quantum Keycodes](quantum_keycodes.md) 26 * [Best Git Practices](newbs_git_best_practices.md)
38 * [Advanced Keycodes](feature_advanced_keycodes.md) 27 * [Contributing to QMK](contributing.md)
39 * [Auto Shift](feature_auto_shift.md) 28 * [Customizing Functionality](custom_quantum_functions.md)
40 * Software Features 29 * [Github Best Practices](getting_started_github.md)
41 * [Combos](feature_combo.md) 30 * [Hand Wiring Guide](hand_wire.md)
42 * [Command](feature_command.md) 31 * [ISP Flashing Guide](isp_flashing_guide.md)
43 * [Debounce API](feature_debounce_type.md) 32 * [Flashing Firmware](flashing.md)
44 * [Dynamic Macros](feature_dynamic_macros.md) 33 * [Keymap Overview](keymap.md)
45 * [Grave Escape](feature_grave_esc.md) 34 * [Learning Resources](newbs_learn_more_resources.md)
46 * [Key Lock](feature_key_lock.md) 35 * [QMK CLI](cli.md)
47 * [Leader Key](feature_leader_key.md) 36 * [Vagrant Guide](getting_started_vagrant.md)
48 * [Macros](feature_macros.md) 37
49 * [Mouse Keys](feature_mouse_keys.md) 38 * QMK Features
50 * [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys) 39 * [Keycodes](keycodes.md)
51 * [Pointing Device](feature_pointing_device.md) 40 * [Basic Keycodes](keycodes_basic.md)
52 * [Space Cadet](feature_space_cadet.md) 41 * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
53 * [Swap Hands](feature_swap_hands.md) 42 * [Quantum Keycodes](quantum_keycodes.md)
54 * [Tap Dance](feature_tap_dance.md) 43 * [Advanced Keycodes](feature_advanced_keycodes.md)
55 * [Terminal](feature_terminal.md) 44 * [Auto Shift](feature_auto_shift.md)
56 * [Unicode](feature_unicode.md)
57 * [Userspace](feature_userspace.md)
58 * Hardware Features
59 * [Audio](feature_audio.md)
60 * [Backlight](feature_backlight.md)
61 * [Bluetooth](feature_bluetooth.md)
62 * [Bootmagic](feature_bootmagic.md)
63 * [Custom Matrix](custom_matrix.md)
64 * [DIP Switch](feature_dip_switch.md)
65 * [Encoders](feature_encoders.md)
66 * [Haptic Feedback](feature_haptic_feedback.md)
67 * [HD44780 LCD Controller](feature_hd44780.md)
68 * [LED Matrix](feature_led_matrix.md)
69 * [OLED Driver](feature_oled_driver.md)
70 * [Proton C Conversion](proton_c_conversion.md)
71 * [PS/2 Mouse](feature_ps2_mouse.md)
72 * [RGB Lighting](feature_rgblight.md)
73 * [RGB Matrix](feature_rgb_matrix.md)
74 * [Split Keyboard](feature_split_keyboard.md)
75 * [Stenography](feature_stenography.md)
76 * [Thermal Printer](feature_thermal_printer.md)
77 * [Velocikey](feature_velocikey.md)
78 45
79* QMK Reference 46 * Software Features
80 * [Config Options](config_options.md) 47 * [Combos](feature_combo.md)
81 * [Make Documentation](getting_started_make_guide.md) 48 * [Command](feature_command.md)
82 * [Documentation Best Practices](documentation_best_practices.md) 49 * [Debounce API](feature_debounce_type.md)
83 * [Documentation Templates](documentation_templates.md) 50 * [Dynamic Macros](feature_dynamic_macros.md)
84 * [Glossary](reference_glossary.md) 51 * [Grave Escape](feature_grave_esc.md)
85 * [Community Layouts](feature_layouts.md) 52 * [Key Lock](feature_key_lock.md)
86 * [Unit Testing](unit_testing.md) 53 * [Leader Key](feature_leader_key.md)
87 * [Useful Functions](ref_functions.md) 54 * [Macros](feature_macros.md)
88 * [Configurator Support](reference_configurator_support.md) 55 * [Mouse Keys](feature_mouse_keys.md)
89 * [info.json Format](reference_info_json.md) 56 * [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)
57 * [Pointing Device](feature_pointing_device.md)
58 * [Space Cadet](feature_space_cadet.md)
59 * [Swap Hands](feature_swap_hands.md)
60 * [Tap Dance](feature_tap_dance.md)
61 * [Terminal](feature_terminal.md)
62 * [Unicode](feature_unicode.md)
63 * [Userspace](feature_userspace.md)
90 64
91* C Development 65 * Hardware Features
92 * [AVR Processors](hardware_avr.md) 66 * [Audio](feature_audio.md)
93 * [Coding Conventions](coding_conventions_c.md) 67 * [Backlight](feature_backlight.md)
94 * [Compatible Microcontrollers](compatible_microcontrollers.md) 68 * [Bluetooth](feature_bluetooth.md)
95 * [Drivers](hardware_drivers.md) 69 * [Bootmagic](feature_bootmagic.md)
96 * [ADC Driver](adc_driver.md) 70 * [Custom Matrix](custom_matrix.md)
97 * [I2C Driver](i2c_driver.md) 71 * [DIP Switch](feature_dip_switch.md)
98 * [WS2812 Driver](ws2812_driver.md) 72 * [Encoders](feature_encoders.md)
99 * [EEPROM Driver](eeprom_driver.md) 73 * [Haptic Feedback](feature_haptic_feedback.md)
100 * [GPIO Controls](internals_gpio_control.md) 74 * [HD44780 LCD Controller](feature_hd44780.md)
101 * [Keyboard Guidelines](hardware_keyboard_guidelines.md) 75 * [LED Matrix](feature_led_matrix.md)
76 * [OLED Driver](feature_oled_driver.md)
77 * [Proton C Conversion](proton_c_conversion.md)
78 * [PS/2 Mouse](feature_ps2_mouse.md)
79 * [RGB Lighting](feature_rgblight.md)
80 * [RGB Matrix](feature_rgb_matrix.md)
81 * [Split Keyboard](feature_split_keyboard.md)
82 * [Stenography](feature_stenography.md)
83 * [Thermal Printer](feature_thermal_printer.md)
84 * [Velocikey](feature_velocikey.md)
102 85
103* Python Development 86 * Other Topics
104 * [Coding Conventions](coding_conventions_python.md) 87 * [Using Eclipse with QMK](other_eclipse.md)
105 * [QMK CLI Config](cli_configuration.md) 88 * [Using VSCode with QMK](other_vscode.md)
106 * [Python CLI Development](cli_development.md)
107 89
108* For a Deeper Understanding
109 * [How Keyboards Work](how_keyboards_work.md)
110 * [Understanding QMK](understanding_qmk.md)
111 90
112* Other Topics 91* Developing QMK
113 * [Using Eclipse with QMK](other_eclipse.md) 92 * QMK Reference
114 * [Using VSCode with QMK](other_vscode.md) 93 * [Translating the QMK Docs](translating.md)
115 * [Support](support.md) 94 * [Config Options](config_options.md)
116 * [Translating the QMK Docs](translating.md) 95 * [Make Documentation](getting_started_make_guide.md)
96 * [Documentation Best Practices](documentation_best_practices.md)
97 * [Documentation Templates](documentation_templates.md)
98 * [Glossary](reference_glossary.md)
99 * [Community Layouts](feature_layouts.md)
100 * [Unit Testing](unit_testing.md)
101 * [Useful Functions](ref_functions.md)
102 * [Configurator Support](reference_configurator_support.md)
103 * [info.json Format](reference_info_json.md)
104
105 * C Development
106 * [AVR Processors](hardware_avr.md)
107 * [Coding Conventions](coding_conventions_c.md)
108 * [Compatible Microcontrollers](compatible_microcontrollers.md)
109 * [Drivers](hardware_drivers.md)
110 * [ADC Driver](adc_driver.md)
111 * [I2C Driver](i2c_driver.md)
112 * [WS2812 Driver](ws2812_driver.md)
113 * [EEPROM Driver](eeprom_driver.md)
114 * [GPIO Controls](internals_gpio_control.md)
115 * [Keyboard Guidelines](hardware_keyboard_guidelines.md)
116
117 * Python Development
118 * [Coding Conventions](coding_conventions_python.md)
119 * [QMK CLI Config](cli_configuration.md)
120 * [Python CLI Development](cli_development.md)
121
122 * For a Deeper Understanding
123 * [How Keyboards Work](how_keyboards_work.md)
124 * [Understanding QMK](understanding_qmk.md)
117 125
118* QMK Internals (In Progress) 126 * QMK Internals (In Progress)
119 * [Defines](internals_defines.md) 127 * [Defines](internals_defines.md)
120 * [Input Callback Reg](internals_input_callback_reg.md) 128 * [Input Callback Reg](internals_input_callback_reg.md)
121 * [Midi Device](internals_midi_device.md) 129 * [Midi Device](internals_midi_device.md)
122 * [Midi Device Setup Process](internals_midi_device_setup_process.md) 130 * [Midi Device Setup Process](internals_midi_device_setup_process.md)
123 * [Midi Util](internals_midi_util.md) 131 * [Midi Util](internals_midi_util.md)
124 * [Send Functions](internals_send_functions.md) 132 * [Send Functions](internals_send_functions.md)
125 * [Sysex Tools](internals_sysex_tools.md) 133 * [Sysex Tools](internals_sysex_tools.md)
diff --git a/docs/faq.md b/docs/faq.md
deleted file mode 100644
index 506f57a72..000000000
--- a/docs/faq.md
+++ /dev/null
@@ -1,6 +0,0 @@
1# Frequently Asked Questions
2
3* [General](faq_general.md)
4* [Building or Compiling QMK](faq_build.md)
5* [Debugging and Troubleshooting QMK](faq_debug.md)
6* [Keymap](faq_keymap.md)
diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md
index ae4b799a9..1c7206cf5 100644
--- a/docs/newbs_getting_started.md
+++ b/docs/newbs_getting_started.md
@@ -1,10 +1,10 @@
1# Introduction 1# Getting Started
2 2
3Your computer keyboard has a processor inside of it, not unlike the one inside your computer. This processor runs software that is responsible for detecting button presses and sending reports about the state of the keyboard when buttons are pressed or released. QMK fills the role of that software, detecting button presses and passing that information on to the host computer. When you build your custom keymap, you are creating the equivalent of an executable program for your keyboard. 3Your computer keyboard has a processor inside of it, not unlike the one inside your computer. This processor runs software that is responsible for detecting button presses and sending reports about the state of the keyboard when buttons are pressed or released. QMK fills the role of that software, detecting button presses and passing that information on to the host computer. When you build your custom keymap, you are creating the equivalent of an executable program for your keyboard.
4 4
5QMK tries to put a lot of power into your hands by making easy things easy, and hard things possible. You don't have to know how to program to create powerful keymaps — you only have to follow a few simple syntax rules. 5QMK tries to put a lot of power into your hands by making easy things easy, and hard things possible. You don't have to know how to program to create powerful keymaps — you only have to follow a few simple syntax rules.
6 6
7# Getting Started 7# Prerequisites
8 8
9Before you can build keymaps, you need to install some software and set up your build environment. This only has to be done once no matter how many keyboards you plan to compile firmware for. 9Before you can build keymaps, you need to install some software and set up your build environment. This only has to be done once no matter how many keyboards you plan to compile firmware for.
10 10
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-12 22:57:37 +0000