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) | |
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 97457b4077..bca26c69f9 100644 --- a/keyboards/infinity60/readme.md +++ b/keyboards/infinity60/readme.md @@ -1,29 +1,14 @@ -Infinity 60% keyboard firmware -====================== +Infinity 60% +============ -## Quantum MK Firmware +A compact community driven keyboard. -For the full Quantum feature list, see [the parent readme](/). +Keyboard Maintainer: QMK Community +Hardware Supported: Infinity 60% PCB +Hardware Availability: https://input.club/devices/infinity-keyboard/ -## Keymaps +Make example for this keyboard (after setting up your build environment): -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. - -Keymaps follow the format **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/` - - -## Compiling - -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. - -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. - -## Flashing - -To flash the firmware to the keyboard - -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. -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. - -**Tip** `make keymap-dfu-util` will also compile the keymap if needed, so you can skip the compilation step if you want to. + make infinity60-default +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. |