Use of shorter sentences should reduce cognitive load. Example shell
commands should improve understanding of the description.
Signed-off-by: Tim Crawford <tcrawford@system76.com>
Internal flashing can result in corrupted or lost OS data. Make this
more explicit for internal flashing, and make it a point for external
flashing.
Signed-off-by: Tim Crawford <tcrawford@system76.com>
Give the process from 0 to built. Due to the implications of doing
something wrong (unbootable machine), flashing is kept separate.
Signed-off-by: Tim Crawford <tcrawford@system76.com>
- General copyright notice
- License info for firmware and tools
- Note about ITE datasheets being unavailable
Signed-off-by: Tim Crawford <tcrawford@system76.com>
Explain why there are no tagged releases, and why the commit hash on
official releases does not match commits from this repo.
Signed-off-by: Tim Crawford <tcrawford@system76.com>
Use hard line breaks to keep the line under 80 columns. Break it into 2
sentences: one explaining the issue, and the other explaining the fix.
Signed-off-by: Tim Crawford <tcrawford@system76.com>
Fix ACPI timeout and delay on S3 resume when holding a key.
A timeout greater than 1ms results in the excessive delay (~10s) still
occurring on an oryp5 (IT8587).
People who are just reading the keyboard customization instructions might overread the dependencies installations sections.
Additionally, installing rustup for the first time requires sourcing cargo's env vars in case the firmware is flashed in the same shell session after installing rustup.
This allows the Configurator to send a `Ec<Box<dyn Access>>` through a
channel to a background thread. This could be done differently, but
presumably there's no reason to have an `Access` implementation this
doesn't apply to.
rustup 1.23.0 (2020-11-27) introduced support for TOML syntax for the
toolchain file. Use this and specify required compoenents.
To ensure you are using a new enough rustup, run:
rustup self update
