keyboards/hillside/52/keymaps/default/readme.md
For easier initial use, this keymap follows the layout of more standard keyboards where possible. It is a starting point for you to tweak over time to suit your preferences better. You can easily customize it with the QMK configurator.
Some of its key features are:
The base layer provides a very standard key layout with four differences:
The default layout is QWERTY with alternatives of Dvorak and Colemak-DH, and the alt/option and win/command key locations are swappable for windows or mac.
<details> <summary>Details of Dvorak and Colemak-DH</summary> The Dvorak and Colemak-DH base layers have identical non-alpha and non-symbol keys as the QWERTY base layer.</details>
Holding down the Nav/Edit key accesses the navigation, editing, number and function layer:
Holding down the SYM key accesses the symbol layer:
Simultaneously holding down the Nav/Edit and Sym keys enables keys to adjust keyboard settings:
If you are coming from a traditional keyboard, with a large set of physical keys, learning to use a column staggered (ergo) and layer-based keyboard, which uses layers instead of finger reaches to access numbers, symbols and functions, will be an adjustment for your muscle memory and your mental keyboard map. This default layout tries to simplify that adjustment by keeping things in the expected spots when possible.
Yet this layout is only a decent compromise and is not optimal for each user. The online configurator makes it easy to tweak this layout to your needs. You can add additional layers or completely switch around what these do.
A good metaphor is to think of your keymap as a bonsai tree that you tweak slightly over time in response to ideas of how it might serve you better.
Some changes you might consider making:
Here are some other keymaps for inspiration and ideas:
Any keymap or keyboard is a set of compromises between priorities. Here are some of the priorities of this keymap.
A theme of the keymap might be "offering but not requiring a better way," offering options for navigation, editing, mods and numbers.
The online configurator provides a straightforward visual way
to work with a simple layout and uses a .json keymap format.
So this default keymap.json was created with the online configurator.
If you wish, you can edit the keymap.json directly in a text editor, compile it and flash it.
Or, you can use the graphical configurator to edit the keymap. To do that:
qmk_firmware/keyboards/hillside/52/keymaps/default/keymap.jsonYou can combine a .json based keymap with more advanced features specified in .c files with a bit more complexity. For example, see pierrec83's Kyria map.
The QMK configurator's .json download has only one key per line, so it is hard to visualize the keymap if editing manually. If you want, the Hillside git repo has a pretty-printing script for the keymap.json file.
As with anything downloaded from the internet, you should take some steps to assure yourself that the script will not harm your computer nor steal your data. The script is short, so reading it should at least convince you it is rearranging and printing the keymap provided, not reading your banking data. See the Hillside wiki for the script.