diff options
author | noroadsleft <18669334+noroadsleft@users.noreply.github.com> | 2018-12-05 16:55:35 -0800 |
---|---|---|
committer | Drashna Jaelre <drashna@live.com> | 2018-12-05 16:55:35 -0800 |
commit | 8ad561c8f091a4baf167ad4d7c90c02383905e38 (patch) | |
tree | fad3e725742f3bd7de30829885c7677973bb0ada /keyboards/handwired/fivethirteen/README.md | |
parent | 58670ef4b75dad47770401167427bbeed1d5e170 (diff) |
Keyboard: handwired/fivethirteen Refactor, Configurator support, and readme cleanup (#4559)
* handwired/fivethirteen: refactor
- Layout macro KEYMAP renamed to LAYOUT
- Default keymap
- now uses #include QMK_KEYBOARD_H
- Removed redundant KC_TRNS definition
- Removed deprecated fn_actions and action_get_macro functions.
* handwired/fivethirteen: Configurator support
* handwired/fivethirteen: readme cleanup
Restructured readme file to be closer to current QMK template.
Couldn't find a photo of an assembled fivethirteen, so deleted the
reference to the photograph.
Renamed to readme.md
Diffstat (limited to 'keyboards/handwired/fivethirteen/README.md')
-rw-r--r-- | keyboards/handwired/fivethirteen/README.md | 28 |
1 files changed, 0 insertions, 28 deletions
diff --git a/keyboards/handwired/fivethirteen/README.md b/keyboards/handwired/fivethirteen/README.md deleted file mode 100644 index a965650fc6..0000000000 --- a/keyboards/handwired/fivethirteen/README.md +++ /dev/null @@ -1,28 +0,0 @@ -fivethirteen keyboard firmware -====================== - -## Quantum MK Firmware - -For the full Quantum feature list, see [the parent readme.md](/doc/README.md). - -## Building - -Download or clone the whole firmware and navigate to the keyboards/handwired/fivethirteen 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. - -Depending on which keymap you would like to use, you will have to compile slightly differently. - -### Default - -To build with the default keymap, simply run `make`. - -### Other Keymaps - -To build the firmware binary hex file with a keymap just do `make` with `keymap` option like: - -``` -$ make keymap=[default|jack|<name>] -``` - -Keymaps follow the format **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/` |