aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2015-10-27 00:48:22 -0400
committerJack Humbert <jack.humb@gmail.com>2015-10-27 00:48:22 -0400
commit5a268d97ec36e97c871b601795105f02999356ab (patch)
treedf6823665581623ae574a7450f8968fc58653171
parenta6913550c8a1c7e6e77c895b6006de79a25e3aee (diff)
downloadqmk_firmware-5a268d97ec36e97c871b601795105f02999356ab.tar.gz
qmk_firmware-5a268d97ec36e97c871b601795105f02999356ab.zip
READMEs
-rw-r--r--README.md4
-rw-r--r--keyboard/planck/PCB_GUIDE.md15
-rw-r--r--keyboard/planck/README.md2
3 files changed, 11 insertions, 10 deletions
diff --git a/README.md b/README.md
index 403faaa40..216077722 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
1Quantum Mechanical Keyboard Firmware 1Quantum MK Firmware
2================================ 2================================
3This is a keyboard firmware with some useful features for Atmel AVR controller, based on the [tmk_keyboard firmware](http://github.com/tmk/tmk_keyboard) 3This is a keyboard firmware with some useful features for Atmel AVR controller, based on the [tmk_keyboard firmware](http://github.com/tmk/tmk_keyboard).
4 4
5Features 5Features
6-------- 6--------
diff --git a/keyboard/planck/PCB_GUIDE.md b/keyboard/planck/PCB_GUIDE.md
index 88a6c0140..10b86bb3b 100644
--- a/keyboard/planck/PCB_GUIDE.md
+++ b/keyboard/planck/PCB_GUIDE.md
@@ -8,16 +8,17 @@
83. 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. 83. 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.
9 9
10### Mac 10### Mac
111. 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`. 111. Install Xcode from the App Store.
122. Install [DFU-Programmer][dfu-prog]. 122. Install the Command Line Tools from `Xcode->Preferences->Downloads`.
133. Install [DFU-Programmer][dfu-prog].
13 14
14### Linux 15### Linux
151. Install AVR GCC with your favorite package manager. 161. Install AVR GCC with your favorite package manager.
162. Install [DFU-Programmer][dfu-prog]. 172. Install [DFU-Programmer][dfu-prog].
17 18
18##Verify Your Installation 19## Verify Your Installation
191. Clone the following repository: https://github.com/jackhumbert/tmk_keyboard 201. Clone the following repository: https://github.com/jackhumbert/qmk_firmware
202. Open a Terminal and `cd` into `tmk_keyboard/keyboard/planck` 212. Open a Terminal and `cd` into `qmk_firmware/keyboard/planck`
213. Run `make`. This should output a lot of information about the build process. 223. Run `make`. This should output a lot of information about the build process.
22 23
23## Using the built-in functions 24## Using the built-in functions
@@ -38,11 +39,11 @@ Generally, the instructions to flash the PCB are as follows:
384. Press the reset button on the PCB/press the key with the `RESET` keycode 394. Press the reset button on the PCB/press the key with the `RESET` keycode
395. `make <arguments> dfu` - use the necessary `KEYMAP=<keymap>` and/or `COMMON=true` arguments here. 405. `make <arguments> dfu` - use the necessary `KEYMAP=<keymap>` and/or `COMMON=true` arguments here.
40 41
41## OLKB keymap 42## Quantum MK Firmware
42 43
43### Keymap 44### Keymap
44 45
45Unlike the other keymaps, prefixing the keycodes with `KC_` is required. A full list of the keycodes is available [here](https://github.com/jackhumbert/tmk_keyboard/blob/master/doc/keycode.txt). For the keycodes available only in the extended keymap, see this [header file](https://github.com/jackhumbert/tmk_keyboard/blob/master/keyboard/planck/keymap_common.h). 46Unlike 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).
46 47
47You can use modifiers with keycodes like this: 48You can use modifiers with keycodes like this:
48 49
diff --git a/keyboard/planck/README.md b/keyboard/planck/README.md
index faaee0958..a733f0793 100644
--- a/keyboard/planck/README.md
+++ b/keyboard/planck/README.md
@@ -2,7 +2,7 @@ Planck keyboard firmware
2====================== 2======================
3DIY/Assembled compact ortholinear 40% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com). 3DIY/Assembled compact ortholinear 40% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com).
4 4
5## OLKB Keymap 5## Quantum MK Firmware
6You have access to a bunch of goodies: 6You have access to a bunch of goodies:
7 7
8- Use `LSFT()`, `LCTL()`, et. al. (listed in keymap_common.h) as modifiers for keys (daisy-chain-able) 8- Use `LSFT()`, `LCTL()`, et. al. (listed in keymap_common.h) as modifiers for keys (daisy-chain-able)