diff options
| author |  skullY <skullydazed@gmail.com> | 2017-08-16 15:08:16 -0700 |
|---|---|---|
| committer |  Jack Humbert <jack.humb@gmail.com> | 2017-08-16 20:36:59 -0400 |
| commit | 4e73b0b8d7750bcddc445b5a52008d4c6cea977d (patch) | |
| tree | e6c54f5d0b334f1e0acc41b6406e8b26900f80b0 /keyboards/pegasushoof/README.md | |
| parent | 2ee0dc7793165eacfe7ee2a4994d557294988f18 (diff) | |
| download | qmk_firmware-4e73b0b8d7750bcddc445b5a52008d4c6cea977d.tar.gz | |
Make the bulk of our keyboards match the readme.md standard
Diffstat (limited to 'keyboards/pegasushoof/README.md')
| -rw-r--r-- | keyboards/pegasushoof/README.md | 28 |
1 files changed, 8 insertions, 20 deletions
diff --git a/keyboards/pegasushoof/README.md b/keyboards/pegasushoof/README.md index 074222c71..c4c152d40 100644 --- a/keyboards/pegasushoof/README.md +++ b/keyboards/pegasushoof/README.md @@ -1,24 +1,12 @@ -pegasushoof keyboard firmware -============================= +Pegasus Hoof Controller +=== -## Quantum MK Firmware +Keyboard Maintainer: QMK Community +Hardware Supported: Pegasus Hoof +Hardware Availability: https://1upkeyboards.com/filco-pegasus-hoof-controller.html -For the full Quantum feature list, see [the parent README.md](/README.md). +Make example for this keyboard (after setting up your build environment): -## Building + make pegasus_hoof-default -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 -``` +See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information. |