update the ZMK firmware descritpion

[280Zo]

The scope of this PR is to update some of the wording about how to use the firmware. It also includes a short description about the firmware.
I've updated the firmware repo that's linked in this doc and it now builds both qwerty and colemak on the main branch. So it might be a good idea to update the wording to keep from confusing users who click on the link looking for different branches.
Cheers!

[burkfers]

Thank you for your submission!

Please also add "nanov" to .wordlist.txt as a workaround to our spellchecker also picking up URLs. I cannot add this as a suggestion as github doesn't allow change suggestions on unchanged files.

nb: Spelling only; I cannot comment on the contents.

[280Zo]

Thanks for catching those spelling mistakes! I've accepted the commits, and added "nanov" to the .wordlist.txt.
Let me know if there's anything else.

[bstiq]

For some reason my other comment doesn't appear.

What's the reason you deleted those, is it not up to date anymore?

---

Note that the official ZMK firmware doesn't support the PMW3610 or mouse movement keys, both of which are used in the firmware above. To get a working firmware I leveraged the work of inorichi to get the PMW3610 driver, and the work of petejohanson for the driver to allow pointer movement and scrolling with keys.

Official ZMK support for mouse keys is being worked on, and when it's merged I'll switch back to the official ZMK firmware for the builds.

[280Zo]

Great question. I should have put that in my initial message.
I'm playing around with other drivers (e.g. the dongle and PMW3610 driver from badjeff), and since it's possible the authors/repos would change, I took that section out.
If you think it's better left in until I merge the changes with main, I'm happy to add it back and then submit another PR if/when the drivers change.

[burkfers]

It seems to me you still mention inorichi's driver and Pete's mouse emulation branch, just moved further up (L. 184f). Only the link the the mouse emulation PR is removed.

Imho the link to the driver used should stay, both to tell the reader where to go for more information, and to give credit to the authors.
Another PR would be greatly appreciated once you do change to another driver.

Alternatively, you could add these descriptions to a readme in your repo and link it here; That way you have the freedom to change the documentation as you change the code. It's not directly relevant to the setup on the user's side, so not having it directly on the help page is fine.

[280Zo]

Thanks for the feedback!
I've had the attribution and links in my readme since I started using them. Screenshot for reference:

---

---

Having the info there instead of the setup guide makes sense to me, but I'll leave the final decision up to you. If you prefer it in both locations, let me know and I'll gladly add another commit to restore the text.

[bstiq]

Thanks for your contribution! 🥳