diff options
Diffstat (limited to 'keyboard/planck/PCB_GUIDE.md')
| -rw-r--r-- | keyboard/planck/PCB_GUIDE.md | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/keyboard/planck/PCB_GUIDE.md b/keyboard/planck/PCB_GUIDE.md index 9ff12d4852..3daf0e0092 100644 --- a/keyboard/planck/PCB_GUIDE.md +++ b/keyboard/planck/PCB_GUIDE.md @@ -3,6 +3,7 @@ ## Setting up the environment ### Windows + 1. Install [WinAVR Tools](http://sourceforge.net/projects/winavr/) for AVR GCC compiler. 2. Install [DFU-Programmer][dfu-prog] (the -win one). 3. Start DFU bootloader on the chip first time you will see 'Found New Hardware Wizard' to install driver. If you install device driver properly you can find chip name like 'ATmega32U4' under 'LibUSB-Win32 Devices' tree on 'Device Manager'. If not you will need to update its driver on 'Device Manager' to the `dfu-programmer` driver. @@ -13,6 +14,7 @@ If you're using homebrew, you can use the following commands: brew tap osx-cross/avr brew install avr-libc + brew install dfu-programmer Otherwise, these instructions will work: @@ -24,6 +26,9 @@ Otherwise, these instructions will work: 1. Install AVR GCC with your favorite package manager. 2. Install [DFU-Programmer][dfu-prog]. +Note that, since it will be directly accessing USB hardware, the +`dfu-programmer` program needs to be run as root. + ## Verify Your Installation 1. Clone the following repository: https://github.com/jackhumbert/qmk_firmware 2. Open a Terminal and `cd` into `qmk_firmware/keyboard/planck` @@ -51,7 +56,7 @@ Generally, the instructions to flash the PCB are as follows: ### Keymap -Unlike the other keymaps, prefixing the keycodes with `KC_` is required. A full list of the keycodes is available [here](https://github.com/jackhumbert/qmk_firmware/blob/master/doc/keycode.txt). For the keycodes available only in the extended keymap, see this [header file](https://github.com/jackhumbert/qmk_firmware/blob/master/quantum/keymap_common.h). +Unlike the other keymaps, prefixing the keycodes with `KC_` is required. A full list of the keycodes is available [here](https://github.com/jackhumbert/qmk_firmware/blob/master/tmk_core/doc/keycode.txt). For the keycodes available only in the extended keymap, see this [header file](https://github.com/jackhumbert/qmk_firmware/blob/master/quantum/keymap_common.h). You can use modifiers with keycodes like this: |