shampoo wrote: 28 Oct 2020, 20:32
Hi
I just went through the manual that darkcruix wrote and it's quite comprehensive. Well done. I do have a few suggestions to make and I'd be more then willing to help write those sections if darkcruix feels it's important.
First, I think a "Quickstart" guide would be useful. When my F77 arrived, there were no keys. I ordered my keys from Unicomp. The barrel inserts were not installed. I did not know they had to be. So after installing the keys, I was wondering why some keys, (backspace, shift..) were binding unless I hit them in the middle of the key. A Quickstart guide would have helped there..
There is extensive content regarding how to install the keys and that is very useful. So I will skip that.
I am a Mac user. So the first thing I wanted to do was remap the keys. This turned out to be very tricky. A Quickstart guide for this would be great.. I am thinking a webpage that contains everything you need.. The files, software and links with documentation. All that info exists in this manual, but my request is to have it as a sort of HOWTO.
Next, if you screw up your firmware upload and "brick" your keyboard (not that I would know..

) then what are the steps to taking apart your keyboard, finding the pads to jump, how to jump it and get back into the boot loader and then finally, how to button the keyboard back up.
J
Thanks so much for taking the time to comment.
Quickstart for keys: I have buried the details too far back in the document. I do have the getting started part (Section 1) but have not mentioned the key installation there. I don't want to make this part too large, but definitely a few words about what to do after you have received the keyboard and how to add the inserts and keys is something I will add. With cross references to the later in-depth info.
Quickstart for the firmware is actually there - I explained for xwhatsit and QMK how to change the layout. Do you think it is not enough or too much as a start? This is section 3 Firmware Overview. I made screenshots on how to start with any of the two major configurations. While QMK is still a closed beta, I can't get into all details, yet, and have to wait until it goes "public". Let me know, what should be made clearer / earlier etc.?
Screwing up Firmware: That is in the works. Section 5 and Section 6 will contain this definitely. The pure hardware dis-assembly and re-assembly is nearly complete (as you mentioned, the same will follow for the firmware).
All comments are super important to make it a document that is really helpful and/or interesting for everyone in the community. So please, let me know what I can do additionally. I made notes in my task list to incorporate your suggestions. Once I have them included (or some of them), I will let this thread know and hopefully you can help me reviewing it.
Apart from the already existing subsections in the document (without content), I have a huge list of other items I want to bring in... just a little syllabus below ... I am a Mac user as well, so you might recognize the app: