logo

qmk_firmware

custom branch of QMK firmware git clone https://anongit.hacktivis.me/git/qmk_firmware.git

readme.md (3586B)

    

  1. # Halcyon Corne's Default Keymap
  2. _This keymap is a copy of the [Corne default keymap](https://github.com/qmk/qmk_firmware/tree/master/keyboards/crkbd/keymaps/default)_
  4. A simple default keymap for the Halcyon Corne
  5. ============================================
  7. Keymaps in general are quite personal, so it is difficult to come up with a default that will suit every user. We hope this keymap serves as a good starting point for your own - although it should be fairly usable out-of-the-box.
  9. What do all these layers do?
  10. ----------------------------
  12. ### Layer 0: Base layer
  14. ![Layer 0](https://i.imgur.com/Ri5cTHqh.png)
  16. This is where your basic letters live.
  18. The homing thumb fingers are used to access the different layers.
  20. * The homing left thumb finger gives access to the Numbers (or lower) layer
  21. * The homing right thumb finger gives access to the Symbols (or raise) layer
  22. * Pressing both homing thumb fingers gives access to the Adjust layer
  24. ### Layer 1: Lower
  26. ![Layer 1](https://i.imgur.com/9h6ZRQLh.png)
  28. The Lower layer gives access to your number keys on the top row. It also exposes the arrow keys in the usual Vim-style layout.
  30. ### Layer 2: Raise
  32. ![Layer 2](https://i.imgur.com/U1pf7pJh.png)
  34. The Raise layer gives access to the symbols. In addition to shifted number keys on the top row, the right hand also exposes the remaining symbol keys, both as shifted and non-shifted variants.
  36. ### Layer 3: Adjust
  38. ![Layer 3](https://i.imgur.com/A6z1DCbh.png)
  40. The Adjust layer exposes RGB adjustment keys on the left hand.
  42. Where is the keymap.c?
  43. ----------------------
  45. The keymap.c file is not published to the repository. It is generated from `keymap.json` by the build system.
  47. This avoids duplicating information and allow users to edit their keymap from the QMK Configurator web interface.
  49. How do I edit and update the keymap?
  50. ------------------------------------
  52. The `keymap.json` file is generated from the QMK Configurator interface and formatted for better readability in the context of the Ferris keyboard.
  54. To edit it, you may:
  55. * Edit it directly from a text editor.
  56. * Edit it from the QMK Configurator.
  58. If you decide to use the latter workflow, here are the steps to follow:
  60. * From the [QMK Configurator](https://config.qmk.fm/#/splitkb/halcyon/corne/rev2/LAYOUT_split_3x5_3), hit the "import QMK keymap json file" button (it has a drawing with an up arrow on it).
  61. * Browse to the location of your keymap (for example, `<your qmk repo>/keyboards/splitkb/halcyon/corne/keymaps/default/keymap.json`)
  62. * Perform any modification to the keymap in the web UI
  63. * Export the keymap to your downloads folder, by hitting the "Export QMK keymap json file" button (it has a drawing with a down arrow on it)
  64. * Replace your original keymap with the one you just downloaded
  66. I want to do more than the JSON format supports!
  67. -------------------------------------------------
  69. While the `json` format is easy to use, it does lack certain functionality - most notably custom OLED or encoder behaviour.
  71. To add this, you need to convert it to the `c` format. Do keep in mind that this is generally a one-way operation.
  73. First, from the root of your qmk repo, move to your keymap folder
  75. ```bash
  76. cd ./keyboards/splitkb/halcyon/corne/keymaps/my_personal_keymap
  77. ```
  79. Next, convert your `keymap.json` to a `keymap.c`
  81. ```bash
  82. qmk json2c -o keymap.c keymap.json
  83. ```
  86. You can add custom C code to the newly generated `keymap.c` file. Do note that you have to use **either** a C file **or** a JSON file - you cannot do both!  
  87. **If a JSON file is present, the C file is ignored.**