-
Notifications
You must be signed in to change notification settings - Fork 22
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: readme and images matching actual Arsenik #26
Conversation
You might want to take a look at my fork to see the READMEs and images rendered, I have changed a lot to match the actual Arsenik, and there is little to no difference between the Ergo‑L article and the Github one actually, so, good news! The main change in the images is that its now in row staggered style, like a laptop keyboard. It’s more beginner-friendly, though it might reduce the overall readability, so I’m not so sure its the right move, what do you think? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this significant improvement!
!’ve left a few suggestions but my main concern is related to the keyboard geometry. ! understand the staggered geometry makes it more obvious that this project is designed with laptop keyboards in mind, but I find that much harder to read and it dismisses the angle-mod.
I’d be in favor of keeping the pseudo ortholinear layouts as I think they can be interpreted as easily as standard keyboards or ergonomic keyboards.
As a side note, maybe the angle mod should not be enabled by default, e.g. if we consider how many could be using ANSI keyboards. But that would be another PR. |
023a0ef
to
d0f43b3
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, I’ve left a couple suggestions.
I’m not sure we should refer to the Symbols layer as the 1dk
layer but that could be addressed in a follow-up.
README.md
Outdated
|
||
Here is some specifities for some supported layouts: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should mention here that Arsenik works out-of-the-box with Lafayette layouts because their AltGr layer already matches Arsenik’s Symbols layer. And Qwerty/Colemak should work too with the same Symbols layer.
The way it is now, it kinda lets me think Arsenik has been designed for Azerty first.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed, I’ve added Ergo‑L/Qwerty‑Lafayette/other Lafayette layouts
and Qwerty/Colemak
blocks.
README.md
Outdated
|
||
### 3. Spice It Up | ||
But the real fun (especially for programmers) happens when we enable the “One | ||
Dead Key” (= 1DK) programmation layer! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I’m not sure “1DK” is relevant in the context of the Symbols layer. (And yes I’m aware this is the org name I’ve chosen…)
We usually refer to this layer as “Lafayette” but I guess “Arsenik” would be okay too.
@Nuclear-Squid wdyt?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1DK layer is really misleading for layouts in the Lafayette Family, on top of it not being relevant in this context so I agree on not using this.
As for Arsenik / Selenium / Lafayette, I’ll be a pedant and say that Lafayette makes more sense : This “prog layer” only serves to emulate what we designed for the Lafayette layouts. It’s not an Arsenik / Selenium innovation, it’s a Lafayette innovation (just like how Selenium has a “vim nav” layer : we didn’t invent arrows on hjkl
, but we are emulating it because it’s really cool).
Yes, the “1DFH philosophy” is shared with Arsenik, but so is a lot of design decisions with the Lafayette layouts, and this prog layer is exactly the same across all of them. If we had a layer to emulate Colemak on Qwerty (for instance), we would have called it a “Colemak layer” without thinking, and I feel “Lafayette” makes sense for the same reason.
- the upper row helps with <kbd>Shift</kbd>-digit shortcuts | ||
- the lower row has dash, comma, dot and slash signs to help with number / date | ||
inputs | ||
- <kbd>Space</kbd> becomes a narrow no-break space for layouts that supports it |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- <kbd>Space</kbd> becomes a narrow no-break space for layouts that supports it | |
- <kbd>Space</kbd> becomes <kbd>Shift</kbd><kbd>Space</kbd>, which can be | |
a no-break space for layouts that support it |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It happens to be shift+space because the layout we support for now have their narrow no-break space with this combo, but the idea is mostly to produce a nnbs, not necessarily with this combo if the defalias of the keyboard layout define nnbs with another combo (I hope you get what I mean by that).
README.md
Outdated
- being the most efficient 3×5 layout — [Miryoku] is probably the most | ||
advanced approach for that, at least on custom 36-key keyboards; and each person | ||
its own configuration for their needs will be more efficient, even if Arsenik | ||
can serve at a starting point |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I’d suggest to replace the sub-sentence after the semicolon by a bullet point, e.g.:
- suiting every user out-of-the-box — Arsenik is proposed as a reasonable default configuration,
but users are encouraged to customize it to suit their personal needs and preferences;
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed, it’s a lot clearer to read. I’ve changed this according to what you suggest.
Co-authored-by: Fabien Cazenave <[email protected]>
No description provided.