diff options
Diffstat (limited to 'docs/getting_started_make_guide.md')
| -rw-r--r-- | docs/getting_started_make_guide.md | 16 |
1 files changed, 7 insertions, 9 deletions
diff --git a/docs/getting_started_make_guide.md b/docs/getting_started_make_guide.md index e51541190..adc1aed75 100644 --- a/docs/getting_started_make_guide.md +++ b/docs/getting_started_make_guide.md | |||
| @@ -93,19 +93,17 @@ This enables MIDI sending and receiving with your keyboard. To enter MIDI send m | |||
| 93 | 93 | ||
| 94 | `UNICODE_ENABLE` | 94 | `UNICODE_ENABLE` |
| 95 | 95 | ||
| 96 | This allows you to send unicode symbols via `UC(<unicode>)` in your keymap. Only codes up to 0x7FFF are currently supported. | 96 | This allows you to send Unicode characters using `UC(<code point>)` in your keymap. Code points up to `0x7FFF` are supported. This covers characters for most modern languages, as well as symbols, but it doesn't cover emoji. |
| 97 | 97 | ||
| 98 | `UNICODEMAP_ENABLE` | 98 | `UNICODEMAP_ENABLE` |
| 99 | 99 | ||
| 100 | This allows sending unicode symbols using `X(<unicode>)` in your keymap. Codes | 100 | This allows you to send Unicode characters using `X(<map index>)` in your keymap. You will need to maintain a mapping table in your keymap file. All possible code points (up to `0x10FFFF`) are supported. |
| 101 | up to 0xFFFFFFFF are supported, including emojis. You will need to maintain | ||
| 102 | a separate mapping table in your keymap file. | ||
| 103 | 101 | ||
| 104 | Known limitations: | 102 | `UCIS_ENABLE` |
| 105 | - Under Mac OS, only codes up to 0xFFFF are supported. | ||
| 106 | - Under Linux ibus, only codes up to 0xFFFFF are supported (but anything important is still under this limit for now). | ||
| 107 | 103 | ||
| 108 | Characters out of range supported by the OS will be ignored. | 104 | 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. |
| 105 | |||
| 106 | For further details, as well as limitations, see the [Unicode page](feature_unicode.md). | ||
| 109 | 107 | ||
| 110 | `BLUETOOTH_ENABLE` | 108 | `BLUETOOTH_ENABLE` |
| 111 | 109 | ||
| @@ -117,7 +115,7 @@ This allows you output audio on the C6 pin (needs abstracting). See the [audio p | |||
| 117 | 115 | ||
| 118 | `FAUXCLICKY_ENABLE` | 116 | `FAUXCLICKY_ENABLE` |
| 119 | 117 | ||
| 120 | Uses buzzer to emulate clicky switches. A cheap imitation of the Cherry blue switches. By default, uses the C6 pin, same as AUDIO_ENABLE. | 118 | Uses buzzer to emulate clicky switches. A cheap imitation of the Cherry blue switches. By default, uses the C6 pin, same as `AUDIO_ENABLE`. |
| 121 | 119 | ||
| 122 | `VARIABLE_TRACE` | 120 | `VARIABLE_TRACE` |
| 123 | 121 | ||
