Skip to content

Commit

Permalink
Readme: Update QMK links. Put wiki link earlier
Browse files Browse the repository at this point in the history
  • Loading branch information
mmccoyd committed Dec 17, 2022
1 parent 1984b19 commit ab07b09
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 14 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,18 +46,10 @@ See the board readmes for details, rationales and default keymaps.
*Keycaps*: Hillside boards are _only_ suitable for choc v1 switches and keycaps based on an 18 x 17mm switch spacing, such as the [MBK](https://mkultra.click/mbk-choc-keycaps), [Lowprokb LDSA](https://lowprokb.ca/products/ldsa-low-profile-blank-keycaps), [MoErgo MCC](https://mkultra.click/moergo-mcc-pom-1u-keycap/) or [Asymplex Choc](https://www.asymplex.xyz/category/choc). Not MX ones, nor 18 x 18mm ones such as Work Louder, nor Kailh Choc Transparent.

Hillside includes both
[QMK firmware](https://github.com/qmk/qmk_firmware/tree/master/keyboards/handwired/hillside)
[QMK firmware](https://github.com/qmk/qmk_firmware/tree/master/keyboards/hillside)
and [ZMK Firmware](https://github.com/mmccoyd/zmk-config).


## Key Use

I expect most people will primarily use either the tucked three thumbs or the extended three (not counting the upper thumb). They can choose where the thumb arc suits them best. I find the thumb finger is best for reaching the upper thumb key; clearing the lower thumb requires some care, but it is still very useful. The middle finger also handily reaches the most tucked thumb key, as the open space is a good reference. The keys outside of the primary three thumb keys are convenient for infrequent lock layers, escape, or for use when not actively typing for things such as mute.

## Why

Creating four boards is more than I intended. I wanted closer keys than MX boards, yet a few more keys than the Sweep (hence the 48). Yet I still missed the fuller bottom row of the Atreus for infrequent keys and felt people new to small boards would prefer a physical arrow cluster (hence the 56). But that put the extra keys too far for me, and I realized many 40% boards tuck the arrow cluster partly into the main rows. So I did that with some splay I wanted (hence the 52). But others like a more minimal board, and removing the partial bottom row was easy (hence the 46). So it was really three experiments for me, plus an easy variant.

## Hardware and Build Guide

See the [wiki](https://github.com/mmccoyd/hillside/wiki)
Expand All @@ -66,6 +58,14 @@ See the [wiki](https://github.com/mmccoyd/hillside/wiki)
See [Forking and Modifying](https://github.com/mmccoyd/hillside/wiki/Forking%20and%20Modifying)
on whether it would be difficult to modify these designs.

## Key Use

I expect most people will primarily use either the tucked three thumbs or the extended three (not counting the upper thumb). They can choose where the thumb arc suits them best. I find the thumb finger is best for reaching the upper thumb key; clearing the lower thumb requires some care, but it is still very useful. The middle finger also handily reaches the most tucked thumb key, as the open space is a good reference. The keys outside of the primary three thumb keys are convenient for infrequent lock layers, escape, or for use when not actively typing for things such as mute.

## Why

Creating four boards is more than I intended. I wanted closer keys than MX boards, yet a few more keys than the Sweep (hence the 48). Yet I still missed the fuller bottom row of the Atreus for infrequent keys and felt people new to small boards would prefer a physical arrow cluster (hence the 56). But that put the extra keys too far for me, and I realized many 40% boards tuck the arrow cluster partly into the main rows. So I did that with some splay I wanted (hence the 52). But others like a more minimal board, and removing the partial bottom row was easy (hence the 46). So it was really three experiments for me, plus an easy variant.

## Acknowledgments

The excellent Low Profile Keyboards and splitkb.com discord communities provided a fertile learning ground.
Expand Down
4 changes: 2 additions & 2 deletions hillside46/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ It has the aggressive stagger of the Ferris plus
finger splay,
a longer thumb arc and break-off outer pinkie columns.

Splaying the columns lets our fingers more naturally follows our hand mechanics.
Splaying the columns lets our fingers more naturally follow our hand mechanics.
See the Hillside [family readme](../README.md) for features common to all hillside boards. Specific to the Hillside 46 are:

* Optional factory parts soldering except for the switches, MCU, TRRS, LEDs and battery switch.
Expand All @@ -20,7 +20,7 @@ See the Hillside [family readme](../README.md) for features common to all hillsi


Hillside includes:
[QMK firmware](https://github.com/qmk/qmk_firmware/tree/master/keyboards/handwired/hillside)
[QMK firmware](https://github.com/qmk/qmk_firmware/tree/master/keyboards/hillside)
with .json, .c,
[via](https://github.com/mmccoyd/hillside/wiki/hill_46/via_config.json) and
[vial](https://github.com/mmccoyd/vial-qmk/tree/hillside_46/keyboards/handwired/hillside/46/keymaps) keymaps,
Expand Down
4 changes: 2 additions & 2 deletions hillside48/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ See the Hillside [family readme](../README.md) for features common to all hillsi
* Reversible 99 x 137mm PCB

Hillside includes both
[QMK firmware](https://github.com/qmk/qmk_firmware/tree/master/keyboards/handwired/hillside)
[QMK firmware](https://github.com/qmk/qmk_firmware/tree/master/keyboards/hillside)
and [ZMK Firmware](https://github.com/mmccoyd/zmk-config).

## Keymap
The default keymap has numbers and symbols along the top layer rows for familiarity, alternate hand modifiers for all keys and a navigation and editing layer. See the [keymap descrition](https://github.com/qmk/qmk_firmware/tree/master/keyboards/handwired/hillside/48/keymaps/default) for details.
The default keymap has numbers and symbols along the top layer rows for familiarity, alternate hand modifiers for all keys and a navigation and editing layer. See the [keymap descrition](https://github.com/qmk/qmk_firmware/tree/master/keyboards/hillside/48/keymaps/default) for details.

```
| ` | Q | W | E | R | T |-------------------| Y | U | I | O | P | BKSPC |
Expand Down
2 changes: 1 addition & 1 deletion hillside52/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ See the Hillside [family readme](../README.md) for features common to all hillsi
* Optional hotswap with Mill-Max switch sockets

Hillside includes:
[QMK firmware](https://github.com/qmk/qmk_firmware/tree/master/keyboards/handwired/hillside)
[QMK firmware](https://github.com/qmk/qmk_firmware/tree/master/keyboards/hillside)
with .json, .c, [via](https://github.com/mmccoyd/hillside/wiki/hill_52/via_config.json) and [vial](https://github.com/mmccoyd/vial-qmk/tree/hillside_52/keyboards/handwired/hillside/52/keymaps) keymaps,
[ZMK Firmware](https://github.com/mmccoyd/zmk-config),
a [keyboard layout editor](http://www.keyboard-layout-editor.com/) loadable [diagram](https://github.com/mmccoyd/hillside/wiki/hill_52/keyboard-layout-editor.json)
Expand Down

0 comments on commit ab07b09

Please sign in to comment.