diff options
| author | noroadsleft <18669334+noroadsleft@users.noreply.github.com> | 2018-12-11 09:19:55 +0100 |
|---|---|---|
| committer | Drashna Jaelre <drashna@live.com> | 2018-12-11 09:19:55 +0100 |
| commit | a003be1e9c195a4e1d74e563eaf261eec0e9a50b (patch) | |
| tree | 69cc33970a4a8c98636a4955a4ad2b7f31faffb4 /keyboards/handwired/pilcrow/readme.md | |
| parent | 3bef186ea6ba9da445a16d2ff72d2737e1d7c974 (diff) | |
| download | qmk_firmware-a003be1e9c195a4e1d74e563eaf261eec0e9a50b.tar.gz qmk_firmware-a003be1e9c195a4e1d74e563eaf261eec0e9a50b.tar.xz | |
handwired/pilcrow Refactor, Configurator support and readme update (#4602)
* handwired/pilcrow: refactor
- layout macro renamed from KEYMAP to LAYOUT
- keymap now uses #include QMK_KEYBOARD_H
- layers reformatted for readability
- removed unused and deprecated fn_actions and action_get_macro blocks
- keymap config.h
- updated to use #pragma once
- removed redundant config.h include
* handwired/pilcrow: Configurator support
* handwired/pilcrow: readme update
Updated readme.md file to use modern template formatting.
Diffstat (limited to 'keyboards/handwired/pilcrow/readme.md')
| -rw-r--r-- | keyboards/handwired/pilcrow/readme.md | 30 |
1 files changed, 8 insertions, 22 deletions
diff --git a/keyboards/handwired/pilcrow/readme.md b/keyboards/handwired/pilcrow/readme.md index 7a7f6d2af..79f22518e 100644 --- a/keyboards/handwired/pilcrow/readme.md +++ b/keyboards/handwired/pilcrow/readme.md @@ -1,28 +1,14 @@ -pilcrow keyboard firmware -====================== +# pilcrow -## Quantum MK Firmware + -For the full Quantum feature list, see [the parent readme](/). +A 4x10 ortholinear keyboard powered by a Teensy. -## Building +Keyboard Maintainer: [The QMK Community](https://github.com/qmk) +Hardware Supported: Teensy-powered pilcrow -Download or clone the whole firmware and navigate to the keyboards/pilcrow folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file. +Make example for this keyboard (after setting up your build environment): -Depending on which keymap you would like to use, you will have to compile slightly differently. + make handwired/pilcrow:default -### Default - -To build with the default keymap, simply run `make default`. - -### Other Keymaps - -Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create a folder with the name of your keymap in the keymaps folder, and see keymap documentation (you can find in top readme.md) and existant keymap files. - -To build the firmware binary hex file with a keymap just do `make` with a keymap like this: - -``` -$ make [default|jack|<name>] -``` - -Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). |