UltimateHackingKeyboard / firmware

Ultimate Hacking Keyboard firmware
Other
418 stars 65 forks source link

Documentation clean-up #787

Closed rpnfan closed 3 months ago

rpnfan commented 3 months ago

https://github.com/UltimateHackingKeyboard/firmware?tab=readme-ov-file

still lists the old fork from Karel, which is not "needed" any longer, because all functions are now part of the main fork.

The second mentioned custom firmware is also not relevant due more option to configure the SecondRole, right?

kareltucek commented 3 months ago

still lists the old fork from Karel, which is not "needed" any longer, because all functions are now part of the main fork.

Indeed.

The second mentioned custom firmware is also not relevant due more option to configure the SecondRole, right?

Well, general feedback on my implementation of secondary roles is that people still struggle to find a configuration that would not cause spurious activations for them, so I don't consider that feature fully solved on UHK side. I.e., I still consider that alternative firmware to be relevant.

mondalaci commented 3 months ago

@kareltucek Do you plan to update the readme? Do you plan to take any (other) steps to resolve this issue? I'm asking because I don't want to leave it hanging.

kareltucek commented 3 months ago

Feel free to do it, I have no strong feelings about it...

mondalaci commented 3 months ago

How about removing the Custom Firmwares section? I think it doesn't add value anymore with the relevant features present in the official firmware.

mhantsch commented 3 months ago

Well, general feedback on my implementation of secondary roles is that people still struggle to find a configuration that would not cause spurious activations for them, so I don't consider that feature fully solved on UHK side. I.e., I still consider that alternative firmware to be relevant.

I am deep into the topic of homerow mods now, and yes, the UHK firmware doesn't get it done well yet for this particular use case. Generally I think the advancedStrategy works pretty well for very common use cases.

kareltucek commented 3 months ago

How about removing the Custom Firmwares section? I think it doesn't add value anymore with the relevant features present in the official firmware.

Feel free to.

mondalaci commented 3 months ago

Done.