From 5a268d97ec36e97c871b601795105f02999356ab Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Tue, 27 Oct 2015 00:48:22 -0400 Subject: [PATCH] READMEs --- README.md | 4 ++-- keyboard/planck/PCB_GUIDE.md | 15 ++++++++------- keyboard/planck/README.md | 2 +- 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 @@ -Quantum Mechanical Keyboard Firmware +Quantum MK Firmware ================================ -This is a keyboard firmware with some useful features for Atmel AVR controller, based on the [tmk_keyboard firmware](http://github.com/tmk/tmk_keyboard) +This is a keyboard firmware with some useful features for Atmel AVR controller, based on the [tmk_keyboard firmware](http://github.com/tmk/tmk_keyboard). Features -------- 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 @@ 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](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]. +1. Install Xcode from the App Store. +2. Install the Command Line Tools from `Xcode->Preferences->Downloads`. +3. 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` +## 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` 3. Run `make`. This should output a lot of information about the build process. ## Using the built-in functions @@ -38,11 +39,11 @@ Generally, the instructions to flash the PCB are as follows: 4. Press the reset button on the PCB/press the key with the `RESET` keycode 5. `make dfu` - use the necessary `KEYMAP=` and/or `COMMON=true` arguments here. -## OLKB keymap +## Quantum MK Firmware ### 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/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). +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). You can use modifiers with keycodes like this: 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 ====================== DIY/Assembled compact ortholinear 40% keyboard by [Ortholinear Keyboards](http://ortholinearkeyboards.com). -## OLKB Keymap +## Quantum MK Firmware You have access to a bunch of goodies: - Use `LSFT()`, `LCTL()`, et. al. (listed in keymap_common.h) as modifiers for keys (daisy-chain-able)