diff options
author | Jack Humbert <jack.humb@gmail.com> | 2016-11-12 20:54:37 -0500 |
---|---|---|
committer | Jack Humbert <jack.humb@gmail.com> | 2016-11-12 20:54:37 -0500 |
commit | 33e62c080c9161a0fc921c90ed299a67fc2e1799 (patch) | |
tree | 253ea910d8f2ba464ab28709f5f93d09b27c05fd /keyboards/pegasushoof/README.md | |
parent | a889b899e2cf52b3b7807d8a7ad39f12e0761a10 (diff) | |
parent | 631b8999a737ec73610f8b569b1f775cadf08172 (diff) |
merging
Diffstat (limited to 'keyboards/pegasushoof/README.md')
-rw-r--r-- | keyboards/pegasushoof/README.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/pegasushoof/README.md b/keyboards/pegasushoof/README.md new file mode 100644 index 0000000000..074222c714 --- /dev/null +++ b/keyboards/pegasushoof/README.md @@ -0,0 +1,24 @@ +pegasushoof keyboard firmware +============================= + +## Quantum MK Firmware + +For the full Quantum feature list, see [the parent README.md](/README.md). + +## Building + +Download or clone the whole firmware and navigate to the `keyboard/pegasushoof` 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 all keymaps, simply run `make`, the `.hex` files will end up in the top directory. + +### Specific Keymap +Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `<name>/keymap.c` in the `keymaps` folder, and see keymap document (you can find in top README.md) and existent keymap files. + +To build the firmware binary hex file with a keymap just enter the keymap directory and type `make`: +``` +$ cd keymaps/default +$ make +``` |