diff options
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 000000000..074222c71 --- /dev/null +++ b/keyboards/pegasushoof/README.md | |||
@@ -0,0 +1,24 @@ | |||
1 | pegasushoof keyboard firmware | ||
2 | ============================= | ||
3 | |||
4 | ## Quantum MK Firmware | ||
5 | |||
6 | For the full Quantum feature list, see [the parent README.md](/README.md). | ||
7 | |||
8 | ## Building | ||
9 | |||
10 | 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. | ||
11 | |||
12 | Depending on which keymap you would like to use, you will have to compile slightly differently. | ||
13 | |||
14 | ### Default | ||
15 | To build all keymaps, simply run `make`, the `.hex` files will end up in the top directory. | ||
16 | |||
17 | ### Specific Keymap | ||
18 | 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. | ||
19 | |||
20 | To build the firmware binary hex file with a keymap just enter the keymap directory and type `make`: | ||
21 | ``` | ||
22 | $ cd keymaps/default | ||
23 | $ make | ||
24 | ``` | ||