Skip to content

Commit

Permalink
doc: add warning for storage
Browse files Browse the repository at this point in the history
Signed-off-by: Haobo Gu <[email protected]>
  • Loading branch information
HaoboGu committed Sep 29, 2024
1 parent 6af6eea commit 34478d5
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions keyboard.toml
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,11 @@ keymap = [
[storage]
# Storage feature is enabled by default
# enabled = false

# !!! Warning: RMK uses last 2 sectors of your microcontroller's flash by default. You have to ensure that those flash space is not used.
# If you're using a bootloader which puts itself at the end of the flast, like Adafruit_nRF52_Bootloader, RMK will break the bootloader.
# Setting the `start_addr` manually to avoid this. See: https://haobogu.github.io/rmk/storage.html

{% if connection == "BLE" -%}
[ble]
enabled = true
Expand Down

0 comments on commit 34478d5

Please sign in to comment.