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)
* Copy (or symlink if you plan on changing often) the `lytedev` folder in this directory of this repo to `qmk_firmware/keyboard/planck/keymaps/lytedev/`
* From `qmk_firmware/keyboard/planck/keymaps/lytedev/`, run `make` to generate your firmware
* Press the flash button on the Planck keyboard
* From `qmk_firmware/keyboard/planck/keymaps/lytedev/` (same as last terminal command directory), run `make dfu` as root (`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 `lytedev/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`
			This contains my `qmk_firmware`-compatible Planck keymap.

			`## 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)
more work on stuff 2016-06-23 22:54:57 -05:00			* Copy (or symlink if you plan on changing often) the `lytedev` folder in this directory of this repo to `qmk_firmware/keyboard/planck/keymaps/lytedev/`
update for newer qmk firmware setup 2016-06-23 22:53:59 -05:00			* From `qmk_firmware/keyboard/planck/keymaps/lytedev/`, run `make` to generate your firmware
added planck keyboard config and readme 2016-04-04 15:44:24 -05:00			`* Press the flash button on the Planck keyboard`
update for newer qmk firmware setup 2016-06-23 22:53:59 -05:00			* From `qmk_firmware/keyboard/planck/keymaps/lytedev/` (same as last terminal command directory), run `make dfu` as root (`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.
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
			`## Modifying`
update for newer qmk firmware setup 2016-06-23 22:53:59 -05:00			Just modify `lytedev/keymap.c` and repeat the steps above for flashing! Easy.
readme sections for modification 2016-04-05 02:14:17 -05:00