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.pull/4604/head
noroadsleft
6 years ago
committed by
Drashna Jaelre
parent
3bef186ea6
commit
a003be1e9c
@ -0,0 +1,53 @@
|
||||
{
|
||||
"keyboard_name": "pilcrow",
|
||||
"url": "",
|
||||
"maintainer": "qmk",
|
||||
"width": 10,
|
||||
"height": 4,
|
||||
"layouts": {
|
||||
"LAYOUT": {
|
||||
"layout": [
|
||||
{"label":"Q", "x":0, "y":0},
|
||||
{"label":"W", "x":1, "y":0},
|
||||
{"label":"E", "x":2, "y":0},
|
||||
{"label":"R", "x":3, "y":0},
|
||||
{"label":"T", "x":4, "y":0},
|
||||
{"label":"Y", "x":5, "y":0},
|
||||
{"label":"U", "x":6, "y":0},
|
||||
{"label":"I", "x":7, "y":0},
|
||||
{"label":"O", "x":8, "y":0},
|
||||
{"label":"P", "x":9, "y":0},
|
||||
{"label":"A", "x":0, "y":1},
|
||||
{"label":"S", "x":1, "y":1},
|
||||
{"label":"D", "x":2, "y":1},
|
||||
{"label":"F", "x":3, "y":1},
|
||||
{"label":"G", "x":4, "y":1},
|
||||
{"label":"H", "x":5, "y":1},
|
||||
{"label":"J", "x":6, "y":1},
|
||||
{"label":"K", "x":7, "y":1},
|
||||
{"label":"L", "x":8, "y":1},
|
||||
{"label":";", "x":9, "y":1},
|
||||
{"label":"Z", "x":0, "y":2},
|
||||
{"label":"X", "x":1, "y":2},
|
||||
{"label":"C", "x":2, "y":2},
|
||||
{"label":"V", "x":3, "y":2},
|
||||
{"label":"B", "x":4, "y":2},
|
||||
{"label":"N", "x":5, "y":2},
|
||||
{"label":"M", "x":6, "y":2},
|
||||
{"label":",", "x":7, "y":2},
|
||||
{"label":".", "x":8, "y":2},
|
||||
{"label":"/", "x":9, "y":2},
|
||||
{"label":"Ctrl", "x":0, "y":3},
|
||||
{"label":"Alt", "x":1, "y":3},
|
||||
{"label":"GUI", "x":2, "y":3},
|
||||
{"label":"MO(1)", "x":3, "y":3},
|
||||
{"label":"Space", "x":4, "y":3},
|
||||
{"label":"Shift / Space", "x":5, "y":3},
|
||||
{"label":"MO(2)", "x":6, "y":3},
|
||||
{"label":"MO(3)", "x":7, "y":3},
|
||||
{"label":"Delete", "x":8, "y":3},
|
||||
{"label":"Esc", "x":9, "y":3}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,8 +1,3 @@
|
||||
#ifndef CONFIG_USER_H
|
||||
#define CONFIG_USER_H
|
||||
|
||||
#include "../../config.h"
|
||||
#pragma once
|
||||
|
||||
// place overrides here
|
||||
|
||||
#endif
|
||||
@ -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).
|
||||
|
||||
Loading…
Reference in new issue