keyboards/planck/readme.md

# Planck

This contains my `qmk_firmware`-compatible Planck keymap.


## Flashing

* Clone and setup the repository at https://github.com/jackhumbert/qmk_firmware.git - pay special attention to the dependencies (for arch users, `pacman -S avr-libc avr-gcc` and `dfu-programmer` in the AUR)
* Run the following command, setting `QMK_DIR` to the directory of the repo you cloned in the last step:

		QMK_DIR="$HOME/qmk_firmware" make

* And then flash your keyboard by pressing the reset button in the bottom of it (or the `RESET` key if you have it programmed in) and run (don't forget to set `QMK_DIR` to the directory of the repo we cloned in the first step!):

		QMK_DIR="$HOME/qmk_firmware" sudo make dfu

**Tip**: If you don't have an extra keyboard to send the `make dfu` command, just prepend `sleep 10 &&` to it to give yourself 10 seconds to hit the flash button.

That should be it! Your Planck keyboard should now be flashed with this layout.


## Modifying

Just modify `keymap.c` and repeat the steps above for flashing! Easy.
added planck keyboard config and readme 2016-04-04 15:44:24 -05:00			`# Planck`
Update ergodox config to move to QMK firmware 2017-05-09 16:58:06 -05:00
added planck keyboard config and readme 2016-04-04 15:44:24 -05:00			This contains my `qmk_firmware`-compatible Planck keymap.

Update ergodox config to move to QMK firmware 2017-05-09 16:58:06 -05:00
added planck keyboard config and readme 2016-04-04 15:44:24 -05:00			`## Flashing`

update for newer qmk firmware setup 2016-06-23 22:53:59 -05:00			* Clone and setup the repository at https://github.com/jackhumbert/qmk_firmware.git - pay special attention to the dependencies (for arch users, `pacman -S avr-libc avr-gcc` and `dfu-programmer` in the AUR)
update to make system and update to keymap for speaker! 2016-07-02 05:35:41 -05:00			* Run the following command, setting `QMK_DIR` to the directory of the repo you cloned in the last step:

Update ergodox config to move to QMK firmware 2017-05-09 16:58:06 -05:00			`QMK_DIR="$HOME/qmk_firmware" make`
update to make system and update to keymap for speaker! 2016-07-02 05:35:41 -05:00
			* And then flash your keyboard by pressing the reset button in the bottom of it (or the `RESET` key if you have it programmed in) and run (don't forget to set `QMK_DIR` to the directory of the repo we cloned in the first step!):

Update ergodox config to move to QMK firmware 2017-05-09 16:58:06 -05:00			`QMK_DIR="$HOME/qmk_firmware" sudo make dfu`
update for newer qmk firmware setup 2016-06-23 22:53:59 -05:00
			Tip: If you don't have an extra keyboard to send the `make dfu` command, just prepend `sleep 10 &&` to it to give yourself 10 seconds to hit the flash button.
added planck keyboard config and readme 2016-04-04 15:44:24 -05:00
			`That should be it! Your Planck keyboard should now be flashed with this layout.`
readme sections for modification 2016-04-05 02:14:17 -05:00
Update ergodox config to move to QMK firmware 2017-05-09 16:58:06 -05:00
readme sections for modification 2016-04-05 02:14:17 -05:00			`## Modifying`
Update ergodox config to move to QMK firmware 2017-05-09 16:58:06 -05:00
update to make system and update to keymap for speaker! 2016-07-02 05:35:41 -05:00			Just modify `keymap.c` and repeat the steps above for flashing! Easy.
readme sections for modification 2016-04-05 02:14:17 -05:00