keyboards/infinity60/readme.md

   1 Infinity 60% keyboard firmware
   2 ======================
   3
   4 ## Quantum MK Firmware
   5
   6 For the full Quantum feature list, see [the parent readme](/).
   7
   8 ## Keymaps
   9
  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.
  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