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/infinity60 | |
| parent | 2ee0dc7793165eacfe7ee2a4994d557294988f18 (diff) | |
| download | qmk_firmware-4e73b0b8d7750bcddc445b5a52008d4c6cea977d.tar.gz qmk_firmware-4e73b0b8d7750bcddc445b5a52008d4c6cea977d.zip | |
Make the bulk of our keyboards match the readme.md standard
Diffstat (limited to 'keyboards/infinity60')
| -rw-r--r-- | keyboards/infinity60/readme.md | 33 |
1 files changed, 9 insertions, 24 deletions
diff --git a/keyboards/infinity60/readme.md b/keyboards/infinity60/readme.md index 97457b407..bca26c69f 100644 --- a/keyboards/infinity60/readme.md +++ b/keyboards/infinity60/readme.md | |||
| @@ -1,29 +1,14 @@ | |||
| 1 | Infinity 60% keyboard firmware | 1 | Infinity 60% |
| 2 | ====================== | 2 | ============ |
| 3 | 3 | ||
| 4 | ## Quantum MK Firmware | 4 | A compact community driven keyboard. |
| 5 | 5 | ||
| 6 | For the full Quantum feature list, see [the parent readme](/). | 6 | Keyboard Maintainer: QMK Community |
| 7 | Hardware Supported: Infinity 60% PCB | ||
| 8 | Hardware Availability: https://input.club/devices/infinity-keyboard/ | ||
| 7 | 9 | ||
| 8 | ## Keymaps | 10 | Make example for this keyboard (after setting up your build environment): |
| 9 | 11 | ||
| 10 | Several versions of keymaps are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create a folder with the name of your keymap in the keymaps folder, and see keymap documentation (you can find in top readme.md) and existant keymap files. | 12 | make infinity60-default |
| 11 | |||
| 12 | Keymaps follow the format **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/` | ||
| 13 | |||
| 14 | |||
| 15 | ## Compiling | ||
| 16 | |||
| 17 | Download or clone the whole firmware and navigate to the keyboards/infinity60 folder. Once your dev env is setup, you'll be able to use the `make` command to both compile your keymap and flash it to your keyboard. | ||
| 18 | |||
| 19 | To just compile, which generates the output files in the `.build` folder at the root of the repository, run `make keymap`, where keymap is the name of the keymap that you want to compile. | ||
| 20 | |||
| 21 | ## Flashing | ||
| 22 | |||
| 23 | To flash the firmware to the keyboard | ||
| 24 | |||
| 25 | 1. First press the flash button on the bottom of the keyboard. If you already have a flah button mapped in a keyboard layout running on the keyboard, you can also use that. | ||
| 26 | 2. Then run `make keymap-dfu-util`, where keymap is the name of the keymap you want to flash. On Linux based operating systems you might need to run the comamnd as root, for example `sudo make keymap-dfu-util` on Ubuntu. | ||
| 27 | |||
| 28 | **Tip** `make keymap-dfu-util` will also compile the keymap if needed, so you can skip the compilation step if you want to. | ||
| 29 | 13 | ||
| 14 | 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. | ||
