summaryrefslogtreecommitdiffstats
path: root/keyboards/pegasushoof/README.md
diff options
context:
space:
mode:
authorDaniel Svensson <dsvensson@gmail.com>2016-05-29 02:48:56 +0200
committerDaniel Svensson <dsvensson@gmail.com>2016-10-13 12:50:54 +0200
commitb73adf0dea567407bd5e6bd7921b607529a2aa4a (patch)
tree58c374de493fbe0b7596a032cbfbd3f052850025 /keyboards/pegasushoof/README.md
parent0a9ad8f335f5b5b9d184d9e5e9ece6cda149df7e (diff)
Support the Pegasus Hoof controller.
Replacement controller for Filco Majestouch TKL keyboards. matrix.c ported from: https://github.com/BathroomEpiphanies/epiphanies_tmk_keyboard More details: http://bathroomepiphanies.com/controllers/
Diffstat (limited to 'keyboards/pegasushoof/README.md')
-rw-r--r--keyboards/pegasushoof/README.md24
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
+```