josh/qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

handwired/pilcrow Refactor, Configurator support and readme update (#4602)

Browse Source 
* 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.
This commit is contained in:
noroadsleft
2018-12-11 00:19:55 -08:00
committed by Drashna Jaelre
parent 3bef186ea6
commit a003be1e9c
5 changed files with 113 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
keyboards/handwired/pilcrow/readme.md
View File

@@ -1,28 +1,14 @@
pilcrow keyboard firmware
======================
# pilcrow
## Quantum MK Firmware
![pilcrow](https://i.imgur.com/KQdn2kg.jpg)
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).