michael/quill
1
0
Fork 0
mirror of https://github.com/Quill-OS/quill.git synced 2024-10-31 21:33:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

LEGAL.md: Add eInk waveforms warning

Browse source
This commit is contained in:
Nicolas Mailloux 2023-06-22 12:47:54 -04:00
parent 8684dded52
commit 2181410904
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
LEGAL.md
View file

@ -7,4 +7,8 @@ This is the official document concerning legal information about InkBox OS. It h
- 'The Software' represents both of the things above. - 'The Software' represents both of the things above.
## Statement ## Statement
The Software is provided to you WITHOUT ANY WARRANTY, and no one but you is responsible if you ever brick your device for any reason whatsoever. The Software is provided to you WITHOUT ANY WARRANTY, and no one but you is responsible if you ever brick your device by installing it.
## Warnings
### Waveform
eInk devices need special data to drive their screen properly. This data is often referenced to as "waveforms", and is usually specific to each device. When distributing images, we cannot guarantee you that the wveform used for our testing device, even if said device *is* of the same model as the one you downloaded it for, will work for yours.<br>Since every eInk display is unique in its conception, every waveform is different, even for the same display model. If inappropriate data is fed to the eInk display's controller, such as wrong voltages for changing the state of a pixel, it can cause permanent damage to the screen. This has been seen happening on Kindle devices with their native firmware, but has yet to be demonstrated on Kobo devices.<br>In summary, you shouldn't be worried of flashing a release image of InkBox OS to your device, since the eInk controller should be tolerant enough to work fine with the input data it receives. If you are using a Kindle Touch, we use an in-kernel "default" waveform provided by Amazon until you provide your own.<br>But exceptions *do* happen, and for them we can't be held responsible for damaging your device.