keyboards/thevankeyboards/bananasplit/keymaps/rask/README.md

   1 # rask's BananaSplit60
   2
   3 ![BS60 layout](http://i.imgur.com/Q7so1py.png)
   4
   5 ## Notes
   6
   7 ### Layers
   8
   9 Base layer is a regular HHKBish ANSI layer. Toggling the
  10 alternate base layer (Fn3) makes it simpler to play games with
  11 the left space being set to be an actual Space.
  12
  13 Layer 1 (Fn1) contains usual 60% functionalities such as the
  14 F-row, while Layer 2 (Fn2) contains media controls.
  15
  16 The final layer (Fn4) is a special layer that acts as a lock
  17 layer, meaning the keyboard is locked while the layer
  18 is active. This firmware assumes a lock switch (read below).
  19
  20 ### Lock switches
  21
  22 1.25u between the split space halves and the 1u key right
  23 left of LeftArrow are to be operated with a lock switch.
  24 If you don't have lock switches you should swap the `MO()`
  25 calls with `TG()` calls to make the layer toggles work
  26 with regular non/locking switches.
  27
  28 ## How to make and flash
  29
  30 (These instructions are for Linux-based operating systems
  31 with `dfu-programmer` available.)
  32
  33 `cd` into the `bananasplit` keyboard's directory and run
  34
  35     make rask
  36
  37 which should result in a file called `bananasplit_rask.hex` appearing
  38 in your QMK root directory.
  39
  40 Now plug in your BananaSplit60 keyboard via USB. Verify
  41 with `lsusb` that it appears. At least my PCB did not have
  42 anything preflashed so you should see `atmega32u4` or similar
  43 in the `lsusb` output.
  44
  45 Now you can flash the firmware by
  46
  47     $ sudo dfu-programmer atmega32u4 erase
  48     $ cd /qmk_firmware/root/directory
  49     $ sudo dfu-programmer atmega32u4 flash bananasplit_rask.hex
  50
  51 _If_ you happen to have some other `atmega32u4` based device
  52 I suggest you plug it out before flashing your BS60 just to
  53 prevent accidentally flashing your old device.