diff options
author | Christopher Browne <cbbrowne@hpaq.int.linuxdatabases.info> | 2016-02-01 20:53:58 -0500 |
---|---|---|
committer | Christopher Browne <cbbrowne@hpaq.int.linuxdatabases.info> | 2016-02-01 20:53:58 -0500 |
commit | a51009f30055b01be77ac4afd1ea765bbf8554a6 (patch) | |
tree | 1de5dddc64ff8f1ff8cb42cf436ef6618c198744 /keyboard/planck/README.md | |
parent | db2d97d8dcadba22f1af6b32858ec1c47c3cb34c (diff) | |
parent | 1466f5a36e24f4b5925e306a10abbfdcde50dd04 (diff) | |
download | qmk_firmware-a51009f30055b01be77ac4afd1ea765bbf8554a6.tar.gz qmk_firmware-a51009f30055b01be77ac4afd1ea765bbf8554a6.zip |
Merge branch 'master' of github.com:cbbrowne/qmk_firmware
Diffstat (limited to 'keyboard/planck/README.md')
-rw-r--r-- | keyboard/planck/README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboard/planck/README.md b/keyboard/planck/README.md index 5c3a52498a..60f0136c48 100644 --- a/keyboard/planck/README.md +++ b/keyboard/planck/README.md @@ -171,6 +171,27 @@ Depending on which keymap you would like to use, you will have to compile slight ### Default To build with the default keymap, simply run `make`. +## Safety Considerations + +You probably don't want to "brick" your keyboard, making it impossible +to rewrite firmware onto it. Here are some of the parameters to show +what things are (and likely aren't) too risky. + +- If a keyboard map does not include RESET, then, to get into DFU + mode, you will need to press the reset button on the PCB, which + requires unscrewing some bits. +- Messing with tmk_core / common files might make the keyboard + inoperable +- Too large a .hex file is trouble; `make dfu` will erase the block, + test the size (oops, wrong order!), which errors out, failing to + flash the keyboard +- DFU tools do /not/ allow you to write into the bootloader (unless + you throw in extra fruitsalad of options), so there is little risk + there. +- EEPROM has around a 100000 write cycle. You shouldn't rewrite the + firmware repeatedly and continually; that'll burn the EEPROM + eventually. + ### Other Keymaps Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `<name>.c` and see keymap document (you can find in top README.md) and existent keymap files. |