You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

105 lines
7.4 KiB

  1. # ninjonas Keymap for [ErgoDox (HotDox)](https://www.alpacakeyboards.com/)
  2. ## Setup
  3. - Ensure you've cloned the [qmk](https://github.com/qmk/qmk_firmware) repo
  4. - Create directory `ninjonas` on `/keyboards/hotdox/keymaps/`
  5. - Run `copy_keymap.sh`. This copies the contents of this repo into `%qmk_firmware%/ninjonas/` directory
  6. - To push your keymap to your keyboard run this command `make clean hotdox:ninjonas:dfu`
  7. - this compiles your keymap and creates a `hotdox_ninjonas.hex` file and will atempt to flash your board
  8. - if you get the following message:
  9. ```
  10. dfu-programmer: no device present.
  11. Error: Bootloader not found. Trying again in 5s.
  12. ```
  13. - Press the reset button underneath your ErgoDox keyboard
  14. - The following messages should show up and your board has successfuly been flashed
  15. ```
  16. Bootloader Version: 0x00 (0)
  17. Erasing flash... Success
  18. Checking memory from 0x0 to 0x6FFF... Empty.
  19. Checking memory from 0x0 to 0x5D7F... Empty.
  20. 0% 100% Programming 0x5D80 bytes...
  21. [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success
  22. 0% 100% Reading 0x7000 bytes...
  23. [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success
  24. Validating... Success
  25. 0x5D80 bytes written into 0x7000 bytes memory (83.48%).
  26. ```
  27. - The alterenative is follow the steps on [Hotdox flashing guide](https://www.alpacakeyboards.com/flash/hot-dox-ergodox-76-flashing-instructions)
  28. ## Keymap
  29. This keymap is designed based off my typing habits and is subject to change. Information about custom user macros and tap dances can be found [here](https://github.com/ninjonas/qmk-yonas/tree/master/users/ninjonas).
  30. ### QWERTY
  31. ```c
  32. /* QWERTY
  33. *
  34. * ,--------------------------------------------------. ,--------------------------------------------------.
  35. * | ` | 1 | 2 | 3 | 4 | 5 | Play | |K_LOCK | 6 | 7 | 8 | 9 | 0 | - |
  36. * |--------+------+------+------+------+-------------| |-------+------+------+------+------+------+--------|
  37. * | Tab | Q | W | E | R | T | | | | Y | U | I | O | P | \ |
  38. * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
  39. * | Esc | A | S | D | F | G |------| |-------| H | J | K | L | ; | ' |
  40. * |--------+------+------+------+------+------| [ | | ] |------+------+------+------+------+--------|
  41. * | LShift | Z | X | C | V | B | | | | N | M | , | . | / | = |
  42. * `--------+------+------+------+------+-------------' `--------------+------+------+------+------+--------'
  43. * | | | Alt | Cmd | Ctl | | BkSP | Del |LOWER | | |
  44. * `----------------------------------' `----------------------------------'
  45. * ,-------------. ,-------------.
  46. * | Up | Down | | Left | Right|
  47. * ,------|------|------| |------+------+------.
  48. * | | | Home | | PgUp | | |
  49. * | Space|Backsp|------| |------| Del |Enter |
  50. * | |ace | End | | PgDn | | |
  51. * `--------------------' `--------------------'
  52. */
  53. ```
  54. ### LOWER
  55. ```c
  56. /* LOWER
  57. *
  58. * ,--------------------------------------------------. ,----------------------------------------------------.
  59. * | F11 | F1 | F2 | F3 | F4 | F5 | | | | F6 | F7 | F8 | F9 | F10 | F12 |
  60. * |--------+------+------+------+------+-------------| |-------+------+------+------+------+-------+--------|
  61. * | | |KC_BRU| Play | Mute | | | | | PgUp | Home | Up | End | | |
  62. * |--------+------+------+------+------+------| | | |------+------+------+------+-------+--------|
  63. * | | |KC_BRD| Next |VolUp | |------| |-------| PgDn | Left | Down |Right |K_LOCK | |
  64. * |--------+------+------+------+------+------| | | |------+------+------+------+-------+--------|
  65. * | | | | Prev |VolDn | | | | | | | | | | |
  66. * `--------+------+------+------+------+-------------' `--------------+------+------+------+-------+--------'
  67. * | | | | | | | | | |M_CODE | |
  68. * `----------------------------------' `-----------------------------------'
  69. * ,-------------. ,-------------.
  70. * | | | | | |
  71. * ,------|------|------| |------+------+------.
  72. * | | | | | | | |
  73. * | | |------| |------| | |
  74. * | | | | | | | |
  75. * `--------------------' `--------------------'
  76. */
  77. ```
  78. ### RAISE
  79. ```c
  80. /* RAISE
  81. *
  82. * ,--------------------------------------------------. ,----------------------------------------------------.
  83. * | | | | | | | | | | | | | | | |
  84. * |--------+------+------+------+------+-------------| |-------+------+------+------+------+-------+--------|
  85. * | | | MS_1 | MS_U | MS_2 | WH_U | | | | | | | | | |
  86. * |--------+------+------+------+------+------| | | |------+------+------+------+-------+--------|
  87. * | | | MS_L | MS_D | MS_R | WH_D |------| |-------| | | | | | |
  88. * |--------+------+------+------+------+------| | | |------+------+------+------+-------+--------|
  89. * | | | | | | | | | | | | | | | |
  90. * `--------+------+------+------+------+-------------' `--------------+------+------+------+-------+--------'
  91. * | | | | | | | | | | | |
  92. * `----------------------------------' `-----------------------------------'
  93. * ,-------------. ,-------------.
  94. * | | | | | |
  95. * ,------|------|------| |------+------+------.
  96. * | | | | | | | |
  97. * | | |------| |------| | |
  98. * | | | | | | | |
  99. * `--------------------' `--------------------'
  100. */
  101. ```