keychron_qmk_firmware/keyboards/ferris/keymaps/pierrec83/readme.md

@pierrec83's personal keymap for the Ferris keyboard
====================================================

This keymap shares many commonalities with the default keymap.
See its readme for a write-up on many of the decisions, including
how to generate the formatted json file with json2crab.py and the
general philosophy for each layer.

Because this is my own keymap, I didn't refrain from using shortcuts
that make sense for me and may not make sense for most.

Key differences from the default keymap include:

Alpha layers:
-------------

Because I only learned to touch type when I switched from qwerty to workman,
my base layer is workman and my layout doesn't contain a qwerty layer.

My layer 1 hosts a variant of RSTHD that I am developing, inspired from workman's
focus on reducing side-index-motion. It should become my end game keymap eventually,
but I still haven't found the time to learn it to a working proficiency.

Secondary thumbs:
-----------------

Instead of a placeholder 0 and 1, the secondary thumbs on my keymap
perform the following actions:
* Navigate to previous and next workspace the base layer
* Navigate to previous and next tab on the mouse layer
* Volume control on layer
* Brightness control on layer

Mouse layer:
------------

* Copy/Paste shortcuts on the left hand, on the upper row.

Always available layer:
-----------------------

* Esc and column are placed differently to allow easy vim navigation with the positions of w and q in the workman base layer
* Enable permanent switch to the RSTHD layer in addition to the mouse layer
Ferris reorganization (#10564) * Add my own keymap * Layer 0: Workman * Layer 1: RSTHD (my own take on it) * Layer 2: Mouse * Layer 3: Navigation * Layer 4: Symbols right * Layer 5: Symbols left * Layer 6: Fn keys * Layer 7: Numbers * Layer 8: Vim and misceallaneaous accessible from any other layer * Move the current code to a 0.1 folder in preparation for upcoming changes Version 0.2 is currently being prototyped and uses an arm chip which will need its own firmware. There is also the Ferris sweep which uses a pro-micro compatible board which will need its own directory. * Move Ferris out of handwired and into the light The keyboard is now well out of the prototype phase as tens of them have been produced and acquired by various people. With 0.2 coming out, adoption is going to increase again as the board will be available for sale at some recognized vendors. Now is probably a good time to recognize its status as more than a prototype :) * Add code for the Ferris Sweep (a.k.a cradio) The Ferris Sweep is a creation of the talented @davidphilipbarr, a.k.a DPB. It has the key layout of a Ferris and uses a pro-micro connected to the switches via direct pins so that diodes are not needed and the soldering is minimal. With their blessing, I took the code for it from DPB's own repo: https://github.com/davidphilipbarr/36keys/tree/master/qmk/cradio and did some adaptations such as removing commented out code, enabling EE_HANDS and mouse keys for consistency with my existing Ferris code. * Fix indentation in rules.mk * Fix indentation in sweep's config * Remove unnecessary lines from sweep's rules.mk * Remove unnecessary lines from sweep's rules.mk * Rename 0.1 to 0_1 This avoids the dot looking like the separation between a filename and its extension. In the same commit, bring matrix.c to the 0_1 folder as this was needed for the code to compile properly (matrix.c is referred to in the readme under `0_1` and is specific to that revision of the firmware). * Update copyright statements for Sweep 2020-10-18 01:20:34 +06:00			`@pierrec83's personal keymap for the Ferris keyboard`
			`====================================================`

			`This keymap shares many commonalities with the default keymap.`
			`See its readme for a write-up on many of the decisions, including`
			`how to generate the formatted json file with json2crab.py and the`
			`general philosophy for each layer.`

			`Because this is my own keymap, I didn't refrain from using shortcuts`
			`that make sense for me and may not make sense for most.`

			`Key differences from the default keymap include:`

			`Alpha layers:`
			`-------------`

			`Because I only learned to touch type when I switched from qwerty to workman,`
			`my base layer is workman and my layout doesn't contain a qwerty layer.`

			`My layer 1 hosts a variant of RSTHD that I am developing, inspired from workman's`
			`focus on reducing side-index-motion. It should become my end game keymap eventually,`
			`but I still haven't found the time to learn it to a working proficiency.`

			`Secondary thumbs:`
			`-----------------`

			`Instead of a placeholder 0 and 1, the secondary thumbs on my keymap`
			`perform the following actions:`
			`* Navigate to previous and next workspace the base layer`
			`* Navigate to previous and next tab on the mouse layer`
			`* Volume control on layer`
			`* Brightness control on layer`

			`Mouse layer:`
			`------------`

			`* Copy/Paste shortcuts on the left hand, on the upper row.`

			`Always available layer:`
			`-----------------------`

			`* Esc and column are placed differently to allow easy vim navigation with the positions of w and q in the workman base layer`
			`* Enable permanent switch to the RSTHD layer in addition to the mouse layer`