aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorskullY <skullydazed@gmail.com>2020-02-25 09:17:24 -0800
committerskullydazed <skullydazed@users.noreply.github.com>2020-03-05 16:00:10 -0800
commit86f6405574d75cdc69c32829cb523aa1538ecd77 (patch)
treee69846cc00da1e849f0c417c1589876ca670aa39
parent99850aabcad51dd4a46ee10c0f5349a4266084fe (diff)
downloadqmk_firmware-86f6405574d75cdc69c32829cb523aa1538ecd77.tar.gz
qmk_firmware-86f6405574d75cdc69c32829cb523aa1538ecd77.zip
More sidebar organization
-rw-r--r--docs/_summary.md155
-rw-r--r--docs/cli_dev_configuration.md (renamed from docs/cli_configuration.md)2
-rw-r--r--docs/getting_started_github.md65
-rw-r--r--docs/newbs_learn_more_resources.md12
4 files changed, 89 insertions, 145 deletions
diff --git a/docs/_summary.md b/docs/_summary.md
index dee8a3198..994d58557 100644
--- a/docs/_summary.md
+++ b/docs/_summary.md
@@ -1,17 +1,20 @@
1* Complete Newbs Guide 1* Complete Newbs Guide
2 * [Introduction](newbs.md) 2 * [Introduction](newbs.md)
3 * [Getting Started](newbs_getting_started.md) 3 * [Setup](newbs_getting_started.md)
4 * [Building Your First Firmware](newbs_building_firmware.md) 4 * [Building Your First Firmware](newbs_building_firmware.md)
5 * [Flashing Firmware](newbs_flashing.md) 5 * [Flashing Firmware](newbs_flashing.md)
6 * [Testing and Debugging](newbs_testing_debugging.md) 6 * [Testing and Debugging](newbs_testing_debugging.md)
7 * [Getting Help](getting_started_getting_help.md) 7 * [Getting Help](getting_started_getting_help.md)
8 * Other Topics
9 * [Learning Resources](newbs_learn_more_resources.md)
10 * [Using Eclipse with QMK](other_eclipse.md)
11 * [Using VSCode with QMK](other_vscode.md)
8 12
9* FAQs 13* FAQs
10 * [General FAQ](faq_general.md) 14 * [General FAQ](faq_general.md)
11 * [Build/Compile QMK](faq_build.md) 15 * [Build/Compile QMK](faq_build.md)
12 * [Debugging/Troubleshooting QMK](faq_debug.md) 16 * [Debugging/Troubleshooting QMK](faq_debug.md)
13 * [Keymap](faq_keymap.md) 17 * [Keymap](faq_keymap.md)
14 * [Driver Installation with Zadig](driver_installation_zadig.md)
15 18
16* Configurator 19* Configurator
17 * [Overview](newbs_building_firmware_configurator.md) 20 * [Overview](newbs_building_firmware_configurator.md)
@@ -20,74 +23,80 @@
20 * [Overview](api_overview.md) 23 * [Overview](api_overview.md)
21 * [API Documentation](api_docs.md) 24 * [API Documentation](api_docs.md)
22 25
26* CLI
27 * [Overview](cli.md)
28 * [Configuration](cli_configuration.md)
29 * [Commands](cli_commands.md)
30
23* Using QMK 31* Using QMK
24 * Guides 32 * Guides
25 * [ARM Debugging Guide](arm_debugging.md)
26 * [Best Git Practices](newbs_git_best_practices.md)
27 * [Contributing to QMK](contributing.md)
28 * [Customizing Functionality](custom_quantum_functions.md) 33 * [Customizing Functionality](custom_quantum_functions.md)
29 * [Flashing ATmega32A (ps2avrgb)](flashing_bootloadhid.md) 34 * [Driver Installation with Zadig](driver_installation_zadig.md)
30 * [Flashing Firmware](flashing.md)
31 * [Github Best Practices](getting_started_github.md)
32 * [Hand Wiring Guide](hand_wire.md)
33 * [ISP Flashing Guide](isp_flashing_guide.md)
34 * [Keymap Overview](keymap.md) 35 * [Keymap Overview](keymap.md)
35 * [Learning Resources](newbs_learn_more_resources.md)
36 * [QMK CLI](cli.md)
37 * [Vagrant Guide](getting_started_vagrant.md) 36 * [Vagrant Guide](getting_started_vagrant.md)
37 * Flashing
38 * [Flashing ATmega32A (ps2avrgb)](flashing_bootloadhid.md)
39 * [Flashing Firmware](flashing.md)
40 * Git Best Practices
41 * [Introduction](newbs_git_best_practices.md)
42 * [Your Fork](newbs_git_using_your_master_branch.md)
43 * [Merge Conflicts](newbs_git_resolving_merge_conflicts.md)
44 * [Fixing Your Branch](newbs_git_resynchronize_a_branch.md)
45 * Keyboard Building
46 * [Hand Wiring Guide](hand_wire.md)
47 * [ISP Flashing Guide](isp_flashing_guide.md)
38 48
39 * QMK Features 49 * Simple Keycodes
40 * Keycodes 50 * [Full List](keycodes.md)
41 * [Full List](keycodes.md) 51 * [Basic Keycodes](keycodes_basic.md)
42 * [Basic Keycodes](keycodes_basic.md) 52 * [Advanced Keycodes](feature_advanced_keycodes.md)
43 * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md) 53 * [Quantum Keycodes](quantum_keycodes.md)
44 * [Quantum Keycodes](quantum_keycodes.md)
45 * [Advanced Keycodes](feature_advanced_keycodes.md)
46 54
47 * Software Features 55 * Advanced Keycodes
48 * [Auto Shift](feature_auto_shift.md) 56 * [Auto Shift](feature_auto_shift.md)
49 * [Combos](feature_combo.md) 57 * [Command](feature_command.md)
50 * [Command](feature_command.md) 58 * [Dynamic Macros](feature_dynamic_macros.md)
51 * [Debounce API](feature_debounce_type.md) 59 * [Grave Escape](feature_grave_esc.md)
52 * [Dynamic Macros](feature_dynamic_macros.md) 60 * [Leader Key](feature_leader_key.md)
53 * [Grave Escape](feature_grave_esc.md) 61 * [Macros](feature_macros.md)
54 * [Key Lock](feature_key_lock.md) 62 * [Mouse Keys](feature_mouse_keys.md)
55 * [Leader Key](feature_leader_key.md) 63 * [Space Cadet Shift](feature_space_cadet.md)
56 * [Macros](feature_macros.md) 64 * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
57 * [Mouse Keys](feature_mouse_keys.md)
58 * [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)
59 * [Pointing Device](feature_pointing_device.md)
60 * [Space Cadet](feature_space_cadet.md)
61 * [Swap Hands](feature_swap_hands.md)
62 * [Tap Dance](feature_tap_dance.md)
63 * [Terminal](feature_terminal.md)
64 * [Unicode](feature_unicode.md)
65 * [Userspace](feature_userspace.md)
66 65
67 * Hardware Features 66 * Software Features
68 * [Audio](feature_audio.md) 67 * [Combos](feature_combo.md)
69 * [Backlight](feature_backlight.md) 68 * [Debounce API](feature_debounce_type.md)
70 * [Bluetooth](feature_bluetooth.md) 69 * [Key Lock](feature_key_lock.md)
71 * [Bootmagic](feature_bootmagic.md) 70 * [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)
72 * [Custom Matrix](custom_matrix.md) 71 * [Pointing Device](feature_pointing_device.md)
73 * [DIP Switch](feature_dip_switch.md) 72 * [Swap Hands](feature_swap_hands.md)
74 * [Encoders](feature_encoders.md) 73 * [Tap Dance](feature_tap_dance.md)
75 * [Haptic Feedback](feature_haptic_feedback.md) 74 * [Terminal](feature_terminal.md)
75 * [Unicode](feature_unicode.md)
76 * [Userspace](feature_userspace.md)
77
78 * Hardware Features
79 * Displays
76 * [HD44780 LCD Controller](feature_hd44780.md) 80 * [HD44780 LCD Controller](feature_hd44780.md)
77 * [LED Matrix](feature_led_matrix.md)
78 * [OLED Driver](feature_oled_driver.md) 81 * [OLED Driver](feature_oled_driver.md)
79 * [Proton C Conversion](proton_c_conversion.md) 82 * Lighting
80 * [PS/2 Mouse](feature_ps2_mouse.md) 83 * [Backlight](feature_backlight.md)
84 * [LED Matrix](feature_led_matrix.md)
81 * [RGB Lighting](feature_rgblight.md) 85 * [RGB Lighting](feature_rgblight.md)
82 * [RGB Matrix](feature_rgb_matrix.md) 86 * [RGB Matrix](feature_rgb_matrix.md)
83 * [Split Keyboard](feature_split_keyboard.md) 87 * [Audio](feature_audio.md)
84 * [Stenography](feature_stenography.md) 88 * [Bluetooth](feature_bluetooth.md)
85 * [Thermal Printer](feature_thermal_printer.md) 89 * [Bootmagic](feature_bootmagic.md)
86 * [Velocikey](feature_velocikey.md) 90 * [Custom Matrix](custom_matrix.md)
87 91 * [DIP Switch](feature_dip_switch.md)
88 * Other Topics 92 * [Encoders](feature_encoders.md)
89 * [Using Eclipse with QMK](other_eclipse.md) 93 * [Haptic Feedback](feature_haptic_feedback.md)
90 * [Using VSCode with QMK](other_vscode.md) 94 * [Proton C Conversion](proton_c_conversion.md)
95 * [PS/2 Mouse](feature_ps2_mouse.md)
96 * [Split Keyboard](feature_split_keyboard.md)
97 * [Stenography](feature_stenography.md)
98 * [Thermal Printer](feature_thermal_printer.md)
99 * [Velocikey](feature_velocikey.md)
91 100
92* Developing QMK 101* Developing QMK
93 * Breaking Changes 102 * Breaking Changes
@@ -96,19 +105,8 @@
96 * History 105 * History
97 * [2019 Aug 30](ChangeLog/20190830.md) 106 * [2019 Aug 30](ChangeLog/20190830.md)
98 107
99 * QMK Reference
100 * [Translating the QMK Docs](translating.md)
101 * [Config Options](config_options.md)
102 * [Make Documentation](getting_started_make_guide.md)
103 * [Documentation Best Practices](documentation_best_practices.md)
104 * [Documentation Templates](documentation_templates.md)
105 * [Glossary](reference_glossary.md)
106 * [Community Layouts](feature_layouts.md)
107 * [Unit Testing](unit_testing.md)
108 * [Useful Functions](ref_functions.md)
109 * [info.json Format](reference_info_json.md)
110
111 * C Development 108 * C Development
109 * [ARM Debugging Guide](arm_debugging.md)
112 * [AVR Processors](hardware_avr.md) 110 * [AVR Processors](hardware_avr.md)
113 * [Coding Conventions](coding_conventions_c.md) 111 * [Coding Conventions](coding_conventions_c.md)
114 * [Compatible Microcontrollers](compatible_microcontrollers.md) 112 * [Compatible Microcontrollers](compatible_microcontrollers.md)
@@ -122,14 +120,27 @@
122 120
123 * Python Development 121 * Python Development
124 * [Coding Conventions](coding_conventions_python.md) 122 * [Coding Conventions](coding_conventions_python.md)
125 * [QMK CLI Config](cli_configuration.md) 123 * [QMK CLI Development](cli_development.md)
126 * [Python CLI Development](cli_development.md) 124 * [QMK CLI Config](cli_dev_configuration.md)
127 125
128 * Configurator Development 126 * Configurator Development
129 * QMK API 127 * QMK API
130 * [Development Environment](api_development_environment.md) 128 * [Development Environment](api_development_environment.md)
131 * [Architecture Overview](api_development_overview.md) 129 * [Architecture Overview](api_development_overview.md)
132 130
131 * QMK Reference
132 * [Contributing to QMK](contributing.md)
133 * [Translating the QMK Docs](translating.md)
134 * [Config Options](config_options.md)
135 * [Make Documentation](getting_started_make_guide.md)
136 * [Documentation Best Practices](documentation_best_practices.md)
137 * [Documentation Templates](documentation_templates.md)
138 * [Glossary](reference_glossary.md)
139 * [Community Layouts](feature_layouts.md)
140 * [Unit Testing](unit_testing.md)
141 * [Useful Functions](ref_functions.md)
142 * [info.json Format](reference_info_json.md)
143
133 * For a Deeper Understanding 144 * For a Deeper Understanding
134 * [How Keyboards Work](how_keyboards_work.md) 145 * [How Keyboards Work](how_keyboards_work.md)
135 * [Understanding QMK](understanding_qmk.md) 146 * [Understanding QMK](understanding_qmk.md)
diff --git a/docs/cli_configuration.md b/docs/cli_dev_configuration.md
index ad9ff291c..1196ab669 100644
--- a/docs/cli_configuration.md
+++ b/docs/cli_dev_configuration.md
@@ -4,7 +4,7 @@ This document explains how `qmk config` works.
4 4
5# Introduction 5# Introduction
6 6
7Configuration for QMK CLI is a key/value system. Each key consists of a subcommand and an argument name separated by a period. This allows for a straightforward and direct translation between config keys and the arguments they set. 7Configuration for the QMK CLI is a key/value system. Each key consists of a subcommand and an argument name separated by a period. This allows for a straightforward and direct translation between config keys and the arguments they set.
8 8
9## Simple Example 9## Simple Example
10 10
diff --git a/docs/getting_started_github.md b/docs/getting_started_github.md
deleted file mode 100644
index 07f523f57..000000000
--- a/docs/getting_started_github.md
+++ /dev/null
@@ -1,65 +0,0 @@
1# How to Use Github with QMK
2
3Github can be a little tricky to those that aren't familiar with it - this guide will walk through each step of forking, cloning, and submitting a pull request with QMK.
4
5?> This guide assumes you're somewhat comfortable with running things at the command line, and have git installed on your system.
6
7Start on the [QMK Github page](https://github.com/qmk/qmk_firmware), and you'll see a button in the upper right that says "Fork":
8
9![Fork on Github](http://i.imgur.com/8Toomz4.jpg)
10
11If you're a part of an organization, you'll need to choose which account to fork it to. In most circumstances, you'll want to fork it to your personal account. Once your fork is completed (sometimes this takes a little while), click the "Clone or Download" button:
12
13![Download from Github](http://i.imgur.com/N1NYcSz.jpg)
14
15And be sure to select "HTTPS", and select the link and copy it:
16
17![HTTPS link](http://i.imgur.com/eGO0ohO.jpg)
18
19From here, enter `git clone --recurse-submodules ` into the command line, and then paste your link:
20
21```
22user@computer:~$ git clone --recurse-submodules https://github.com/whoeveryouare/qmk_firmware.git
23Cloning into 'qmk_firmware'...
24remote: Enumerating objects: 9, done.
25remote: Counting objects: 100% (9/9), done.
26remote: Compressing objects: 100% (5/5), done.
27remote: Total 183883 (delta 5), reused 4 (delta 4), pack-reused 183874
28Receiving objects: 100% (183883/183883), 132.90 MiB | 9.57 MiB/s, done.
29Resolving deltas: 100% (119972/119972), done.
30...
31Submodule path 'lib/chibios': checked out '587968d6cbc2b0e1c7147540872f2a67e59ca18b'
32Submodule path 'lib/chibios-contrib': checked out 'ede48346eee4b8d6847c19bc01420bee76a5e486'
33Submodule path 'lib/googletest': checked out 'ec44c6c1675c25b9827aacd08c02433cccde7780'
34Submodule path 'lib/lufa': checked out 'ce10f7642b0459e409839b23cc91498945119b4d'
35Submodule path 'lib/ugfx': checked out '3e97b74e03c93631cdd3ddb2ce43b963fdce19b2'
36```
37
38You now have your QMK fork on your local machine, and you can add your keymap, compile it and flash it to your board. Once you're happy with your changes, you can add, commit, and push them to your fork like this:
39
40```
41user@computer:~$ git add .
42user@computer:~$ git commit -m "adding my keymap"
43[master cccb1608] adding my keymap
44 1 file changed, 1 insertion(+)
45 create mode 100644 keyboards/planck/keymaps/mine/keymap.c
46user@computer:~$ git push
47Counting objects: 1, done.
48Delta compression using up to 4 threads.
49Compressing objects: 100% (1/1), done.
50Writing objects: 100% (1/1), 1.64 KiB | 0 bytes/s, done.
51Total 1 (delta 1), reused 0 (delta 0)
52remote: Resolving deltas: 100% (1/1), completed with 1 local objects.
53To https://github.com/whoeveryouare/qmk_firmware.git
54 + 20043e64...7da94ac5 master -> master
55```
56
57Your changes now exist on your fork on Github - if you go back there (`https://github.com/<whoeveryouare>/qmk_firmware`), you can create a "New Pull Request" by clicking this button:
58
59![New Pull Request](http://i.imgur.com/DxMHpJ8.jpg)
60
61Here you'll be able to see exactly what you've committed - if it all looks good, you can finalize it by clicking "Create Pull Request":
62
63![Create Pull Request](http://i.imgur.com/Ojydlaj.jpg)
64
65After submitting, we may talk to you about your changes, ask that you make changes, and eventually accept it! Thanks for contributing to QMK :)
diff --git a/docs/newbs_learn_more_resources.md b/docs/newbs_learn_more_resources.md
index 9b77db8fd..9e33acb0d 100644
--- a/docs/newbs_learn_more_resources.md
+++ b/docs/newbs_learn_more_resources.md
@@ -2,14 +2,12 @@
2 2
3These resources are aimed at giving new members in the QMK community more understanding to the information provided in the Newbs docs. 3These resources are aimed at giving new members in the QMK community more understanding to the information provided in the Newbs docs.
4 4
5Command Line resources:
6
7* [Good General Tutorial on Command Line](https://www.codecademy.com/learn/learn-the-command-line)
8
5Git resources: 9Git resources:
6 10
7* [Great General Tutorial](https://www.codecademy.com/learn/learn-git) 11* [Great General Tutorial](https://www.codecademy.com/learn/learn-git)
12* [Flight Rules For Git](https://github.com/k88hudson/git-flight-rules)
8* [Git Game To Learn From Examples](https://learngitbranching.js.org/) 13* [Git Game To Learn From Examples](https://learngitbranching.js.org/)
9* [Git Resources to Learn More About Github](getting_started_github.md)
10* [Git Resources Aimed Specifically toward QMK](contributing.md)
11
12
13Command Line resources:
14
15* [Good General Tutorial on Command Line](https://www.codecademy.com/learn/learn-the-command-line)