summaryrefslogtreecommitdiff
path: root/keyboard/planck/PCB_GUIDE.md
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2015-08-16 17:56:15 -0400
committerJack Humbert <jack.humb@gmail.com>2015-08-16 17:56:15 -0400
commitc9cbff446f58262ef9c26b7ce280f37e36b15b9a (patch)
tree1917ebd3b78dfbad7a6555b5ce425c551ca356ca /keyboard/planck/PCB_GUIDE.md
parentc5a8287dea6f5d9d798d0ea5b43b08d2c362c71d (diff)
parente12c0de608be5b3239222735bb6403e0fda3fb26 (diff)
merging
Diffstat (limited to 'keyboard/planck/PCB_GUIDE.md')
-rw-r--r--keyboard/planck/PCB_GUIDE.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/keyboard/planck/PCB_GUIDE.md b/keyboard/planck/PCB_GUIDE.md
index 833e144b3b..c3004c75a4 100644
--- a/keyboard/planck/PCB_GUIDE.md
+++ b/keyboard/planck/PCB_GUIDE.md
@@ -3,26 +3,32 @@
## Setting up the environment
### Windows
-1. Install [MHV AVR Tools][mhv] for AVR GCC compiler and [Cygwin][cygwin](or [MinGW][mingw]) for shell terminal.
+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.
### Mac
-1. Install [CrossPack](https://www.obdev.at/downloads/crosspack/CrossPack-AVR-20131216.dmg).
+1. Install [CrossPack](http://www.obdev.at/products/crosspack/index.html) or install Xcode from the App Store and install the Command Line Tools from `Xcode->Preferences->Downloads`.
2. Install [DFU-Programmer][dfu-prog].
### Linux
1. Install AVR GCC with your favorite package manager.
2. Install [DFU-Programmer][dfu-prog].
+##Verify Your Installation
+1. Clone the following repository: https://github.com/jackhumbert/tmk_keyboard
+2. Open a Terminal and `cd` into `tmk_keyboard/keyboard/planck`
+3. Run `make`. This should output a lot of information about the build process.
+
## Using the built-in functions
-Here is a list of some of the functions avaiable from the command line:
+Here is a list of some of the functions available from the command line:
* `make clean`: clean the environment - may be required in-between builds
* `make`: compile the code
* `make COMMON=true`: compile with the common (non-extended) keymap
-* `make KEYMAP=<keymap>`: compile with the extended keymap file `extended_keymaps_extended_keymap_<keymap>.c`
+* `make MATRIX=<matrix_file>`: compile with the referenced matrix file. Default if unspecified is `matrix_pcb.c`. For handwired boards, use `matrix_handwired.c`.
+* `make KEYMAP=<keymap>`: compile with the extended keymap file `extended_keymaps/extended_keymap_<keymap>.c`
* `make COMMON=true KEYMAP=<keymap>`: compile with the common keymap file `common_keymaps/keymap_<keymap>.c`
* `make dfu`: build and flash the layout to the PCB
* `make dfu-force`: build and force-flash the layout to the PCB (may be require for first flash)
@@ -76,7 +82,7 @@ A number of other keycodes have been added that you may find useful:
### Function layers
-The extended keymap extends the number of function layers from 32 to the near-infinite value of 256. Rather than using `FN<num>` notation (still avaiable, but limited to `FN0`-`FN31`), you can use the `FUNC(<num>)` notation. `F(<num>)` is a shortcut for this.
+The extended keymap extends the number of function layers from 32 to the near-infinite value of 256. Rather than using `FN<num>` notation (still available, but limited to `FN0`-`FN31`), you can use the `FUNC(<num>)` notation. `F(<num>)` is a shortcut for this.
The function actions are unchanged, and you can see the full list of them [here](https://github.com/jackhumbert/tmk_keyboard/blob/master/common/action_code.h). They are explained in detail [here](https://github.com/jackhumbert/tmk_keyboard/blob/master/doc/keymap.md#2-action).