reversebias / mitosis

Firmware for nordic MCUs used in the Mitosis Keyboard
GNU General Public License v3.0
195 stars 125 forks source link

Documentation Improvement Request #9

Open kendotpm opened 6 years ago

kendotpm commented 6 years ago

As a newbie approaching this project from no experience, here's the things that were / are still really difficult to help me get going:

  1. As referenced in #5 and subsequently my recent issue from #8, the link to the nRF sdk makes it appear as if you cannot get to version 11. For me, I ended up grabbing the newer stuff, ultimately creating the error both @joric and I ran into. We need to be able to get to version 11 to get the newbie friendly program.sh running and to be able to build your custom make files.
  2. A folder structure after all unzipping and downloading would have been really helpful. I had actually missed things by 1 nested folder and it made following the guide really difficult. This is quite an RTFM type of user error, but it'd help just sanity checking things as a new user.
  3. Overall understanding of what needs to be flashed to the hands, and what needs to be flashed to the receiver at a high level. I'm actually still unsure.
  4. Specific instructions of what and how to flash to the receiver, similar to the instructions for flashing to the hands. I'm still unsure.
  5. Pairing instructions to link the hands to the receiver. There's a Pairing button on the receiver (discovered through the build log on imgur), but I'm not actually sure how the lights should react and whether my flashing is faulty or my soldering is faulty.

The README assumes a lot of knowledge, and that's probably ok, but I'm in love with this keyboard and it's currently a frustrating mystery to me as a newbie to the keyboard building world. A little time spent on docs would go a really long way!

joric commented 6 years ago

@krazyken04 Pairing button doesn't do anything actually, addresses are hardcoded, also there's no encryption. I haven't done much testing - it either works or not (In my case it didn't, because of the memory placement issue I fixed in https://github.com/reversebias/mitosis/pull/7, it took a week to notice an inconsistency in the configuration files).

datagrok commented 6 years ago

This person has created a repo to collect some supplementary documentation: https://github.com/babarrett/mitosis-docs

Regarding 3: