jackhumbert / pinebook-pro-keyboard-updater

A keyboard/touchpad firmware and updater for the Pinebook Pro
80 stars 11 forks source link

Minor typo in README.md #30

Open Lady-Galadriel opened 4 years ago

Lady-Galadriel commented 4 years ago

While updating my ISO Pinebook Pro, I overlooked something in the instructions because of a typo. It's in this file, README.md as below;

Update all firmwares

You need to do all of that in correct order, if at any point process fails, start it from point 1.:

1    Run step-1 iso or step-1 ansi of update process: sudo ./updater step-1 iso,
2    After step-1 iso or step-1 ansi touchpad will not work, keyboard works as normal (this is true only for ISO, the ANSI keyboard will not work after step-1),
3    Reboot with sudo reboot,
4    After reboot, run step-2 iso or step-2 ansi of update process: sudo ./updater step-2,
5    Reboot with sudo reboot,
6    After reboot, your keyboard and touchpad firmware should be updated.

Note the end of step 4 does not have the example of iso like step 1 does. So, when I copied and pasted the entry, it of course failed, (seq fault if I remember correctly). I figured out my problem pretty quick, but for consistency step 4 should read;

4    After reboot, run step-2 iso or step-2 ansi of update process: sudo ./updater step-2 iso

Ideally the updater code should check for the parameters and give simple, descriptive errors on missing or invalid parameters. But I guess that could be a different issue.

Thank you

theotherjimmy commented 4 years ago

While we're cleaning up that part of the readme, we shold fix step 2. As it stands, you really ought to read the thing in parenthesis. Instead, we could say:

2. After step-1 iso, the touchpad will not work; after step-1 ansi, the touchpad will not work and the keyboard will not work.

I think this wording is more clear.