diff options
| author | Nick Brassel <nick@tzarc.org> | 2024-05-30 12:00:41 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-30 12:00:41 +1000 |
| commit | 6ef97172889ccd5db376b2a9f8825489e24fdac4 (patch) | |
| tree | 334e3bf41c8554d4bee73a140822f95f60eb64e9 /docs/getting_started_make_guide.md | |
| parent | 395766657ff98a4b1fd0dcba5917557f8acbb9e4 (diff) | |
Vitepress conversion of docs. (#23795)
Diffstat (limited to 'docs/getting_started_make_guide.md')
| -rw-r--r-- | docs/getting_started_make_guide.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/getting_started_make_guide.md b/docs/getting_started_make_guide.md index 3d98e4602b..8a66a65c21 100644 --- a/docs/getting_started_make_guide.md +++ b/docs/getting_started_make_guide.md | |||
| @@ -15,8 +15,8 @@ The `<target>` means the following | |||
| 15 | * If no target is given, then it's the same as `all` below | 15 | * If no target is given, then it's the same as `all` below |
| 16 | * `all` compiles as many keyboard/revision/keymap combinations as specified. For example, `make planck/rev4:default` will generate a single .hex, while `make planck/rev4:all` will generate a hex for every keymap available to the planck. | 16 | * `all` compiles as many keyboard/revision/keymap combinations as specified. For example, `make planck/rev4:default` will generate a single .hex, while `make planck/rev4:all` will generate a hex for every keymap available to the planck. |
| 17 | * `flash`, `dfu`, `teensy`, `avrdude`, `dfu-util`, or `bootloadhid` compile and upload the firmware to the keyboard. If the compilation fails, then nothing will be uploaded. The programmer to use depends on the keyboard. For most keyboards it's `dfu`, but for ChibiOS keyboards you should use `dfu-util`, and `teensy` for standard Teensys. To find out which command you should use for your keyboard, check the keyboard specific readme. | 17 | * `flash`, `dfu`, `teensy`, `avrdude`, `dfu-util`, or `bootloadhid` compile and upload the firmware to the keyboard. If the compilation fails, then nothing will be uploaded. The programmer to use depends on the keyboard. For most keyboards it's `dfu`, but for ChibiOS keyboards you should use `dfu-util`, and `teensy` for standard Teensys. To find out which command you should use for your keyboard, check the keyboard specific readme. |
| 18 | Visit the [Flashing Firmware](flashing.md) guide for more details of the available bootloaders. | 18 | Visit the [Flashing Firmware](flashing) guide for more details of the available bootloaders. |
| 19 | * **Note**: some operating systems need privileged access for these commands to work. This means that you may need to setup [`udev rules`](faq_build.md#linux-udev-rules) to access these without root access, or to run the command with root access (`sudo make planck/rev4:default:flash`). | 19 | * **Note**: some operating systems need privileged access for these commands to work. This means that you may need to setup [`udev rules`](faq_build#linux-udev-rules) to access these without root access, or to run the command with root access (`sudo make planck/rev4:default:flash`). |
| 20 | * `clean`, cleans the build output folders to make sure that everything is built from scratch. Run this before normal compilation if you have some unexplainable problems. | 20 | * `clean`, cleans the build output folders to make sure that everything is built from scratch. Run this before normal compilation if you have some unexplainable problems. |
| 21 | * `distclean` removes .hex files and .bin files. | 21 | * `distclean` removes .hex files and .bin files. |
| 22 | 22 | ||
| @@ -115,19 +115,19 @@ This allows you to send Unicode characters using `UM(<map index>)` in your keyma | |||
| 115 | 115 | ||
| 116 | This allows you to send Unicode characters by inputting a mnemonic corresponding to the character you want to send. You will need to maintain a mapping table in your keymap file. All possible code points (up to `0x10FFFF`) are supported. | 116 | This allows you to send Unicode characters by inputting a mnemonic corresponding to the character you want to send. You will need to maintain a mapping table in your keymap file. All possible code points (up to `0x10FFFF`) are supported. |
| 117 | 117 | ||
| 118 | For further details, as well as limitations, see the [Unicode page](feature_unicode.md). | 118 | For further details, as well as limitations, see the [Unicode page](feature_unicode). |
| 119 | 119 | ||
| 120 | `AUDIO_ENABLE` | 120 | `AUDIO_ENABLE` |
| 121 | 121 | ||
| 122 | This allows you output audio on the C6 pin (needs abstracting). See the [audio page](feature_audio.md) for more information. | 122 | This allows you output audio on the C6 pin (needs abstracting). See the [audio page](feature_audio) for more information. |
| 123 | 123 | ||
| 124 | `VARIABLE_TRACE` | 124 | `VARIABLE_TRACE` |
| 125 | 125 | ||
| 126 | Use this to debug changes to variable values, see the [tracing variables](unit_testing.md#tracing-variables) section of the Unit Testing page for more information. | 126 | Use this to debug changes to variable values, see the [tracing variables](unit_testing#tracing-variables) section of the Unit Testing page for more information. |
| 127 | 127 | ||
| 128 | `KEY_LOCK_ENABLE` | 128 | `KEY_LOCK_ENABLE` |
| 129 | 129 | ||
| 130 | This enables [key lock](feature_key_lock.md). | 130 | This enables [key lock](feature_key_lock). |
| 131 | 131 | ||
| 132 | `SPLIT_KEYBOARD` | 132 | `SPLIT_KEYBOARD` |
| 133 | 133 | ||
| @@ -139,7 +139,7 @@ As there is no standard split communication driver for ARM-based split keyboards | |||
| 139 | 139 | ||
| 140 | `CUSTOM_MATRIX` | 140 | `CUSTOM_MATRIX` |
| 141 | 141 | ||
| 142 | Lets you replace the default matrix scanning routine with your own code. For further details, see the [Custom Matrix page](custom_matrix.md). | 142 | Lets you replace the default matrix scanning routine with your own code. For further details, see the [Custom Matrix page](custom_matrix). |
| 143 | 143 | ||
| 144 | `DEBOUNCE_TYPE` | 144 | `DEBOUNCE_TYPE` |
| 145 | 145 | ||
| @@ -147,7 +147,7 @@ Lets you replace the default key debouncing routine with an alternative one. If | |||
| 147 | 147 | ||
| 148 | `DEFERRED_EXEC_ENABLE` | 148 | `DEFERRED_EXEC_ENABLE` |
| 149 | 149 | ||
| 150 | Enables deferred executor support -- timed delays before callbacks are invoked. See [deferred execution](custom_quantum_functions.md#deferred-execution) for more information. | 150 | Enables deferred executor support -- timed delays before callbacks are invoked. See [deferred execution](custom_quantum_functions#deferred-execution) for more information. |
| 151 | 151 | ||
| 152 | ## Customizing Makefile Options on a Per-Keymap Basis | 152 | ## Customizing Makefile Options on a Per-Keymap Basis |
| 153 | 153 | ||
