diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2016-02-07 10:41:00 -0500 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2016-02-07 10:41:00 -0500 |
| commit | e6a2c77fdeba1fa2cebc895e22858b61ea7174ac (patch) | |
| tree | 7b27c8680c416952e1dd51474fb6fcfd663ab325 /keyboard/planck | |
| parent | 623666888fd0235476c1024fb937399c2185431f (diff) | |
| download | qmk_firmware-e6a2c77fdeba1fa2cebc895e22858b61ea7174ac.tar.gz qmk_firmware-e6a2c77fdeba1fa2cebc895e22858b61ea7174ac.zip | |
README changes
Diffstat (limited to 'keyboard/planck')
| -rw-r--r-- | keyboard/planck/README.md | 23 |
1 files changed, 1 insertions, 22 deletions
diff --git a/keyboard/planck/README.md b/keyboard/planck/README.md index 5009e592f..3ba0cc152 100644 --- a/keyboard/planck/README.md +++ b/keyboard/planck/README.md | |||
| @@ -4,7 +4,7 @@ DIY/Assembled compact ortholinear 40% keyboard by [Ortholinear Keyboards](http:/ | |||
| 4 | 4 | ||
| 5 | ## Quantum MK Firmware | 5 | ## Quantum MK Firmware |
| 6 | 6 | ||
| 7 | 7 | For the full Quantum feature list, see [the parent README.md](/README.md). | |
| 8 | 8 | ||
| 9 | ## Building | 9 | ## Building |
| 10 | 10 | ||
| @@ -15,27 +15,6 @@ Depending on which keymap you would like to use, you will have to compile slight | |||
| 15 | ### Default | 15 | ### Default |
| 16 | To build with the default keymap, simply run `make`. | 16 | To build with the default keymap, simply run `make`. |
| 17 | 17 | ||
| 18 | ## Safety Considerations | ||
| 19 | |||
| 20 | You probably don't want to "brick" your keyboard, making it impossible | ||
| 21 | to rewrite firmware onto it. Here are some of the parameters to show | ||
| 22 | what things are (and likely aren't) too risky. | ||
| 23 | |||
| 24 | - If a keyboard map does not include RESET, then, to get into DFU | ||
| 25 | mode, you will need to press the reset button on the PCB, which | ||
| 26 | requires unscrewing some bits. | ||
| 27 | - Messing with tmk_core / common files might make the keyboard | ||
| 28 | inoperable | ||
| 29 | - Too large a .hex file is trouble; `make dfu` will erase the block, | ||
| 30 | test the size (oops, wrong order!), which errors out, failing to | ||
| 31 | flash the keyboard | ||
| 32 | - DFU tools do /not/ allow you to write into the bootloader (unless | ||
| 33 | you throw in extra fruitsalad of options), so there is little risk | ||
| 34 | there. | ||
| 35 | - EEPROM has around a 100000 write cycle. You shouldn't rewrite the | ||
| 36 | firmware repeatedly and continually; that'll burn the EEPROM | ||
| 37 | eventually. | ||
| 38 | |||
| 39 | ### Other Keymaps | 18 | ### Other Keymaps |
| 40 | 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. | 19 | 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. |
| 41 | 20 | ||
