Skip to content

Commit

Permalink
Added more warnings after issue #5
Browse files Browse the repository at this point in the history
See issue #5 for more details.
  • Loading branch information
bulletmark committed Sep 23, 2015
1 parent d5b35bc commit 3215e49
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 10 deletions.
24 changes: 24 additions & 0 deletions Makefile
@@ -0,0 +1,24 @@
# Copyright (C) 2012 Mark Blakeney, markb@berlios.de. This program is
# distributed under the terms of the GNU General Public License.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or any
# later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License at <http://www.gnu.org/licenses/> for more
# details.

SRC = README.md
DOC = $(SRC:.md=.html)

doc: $(DOC)

$(DOC): $(SRC)
markdown $< >$@

clean:
rm -rf $(DOC)
25 changes: 15 additions & 10 deletions README.md
Expand Up @@ -4,8 +4,10 @@ This utility will read and/or write a display's EDID data structure. Use
it with the edid-decode utility to view and check an EDID.
You can also write new EDID data to attempt to fix a corrupt EDID.

*WARNING - THIS UTILITY CAN DESTROY YOUR DISPLAY IF RUN INCORRECTLY. Be
very sure you understand what you are doing.*
*WARNING - THIS UTILITY CAN DESTROY YOUR DISPLAY OR MOTHERBOARD
IF RUN INCORRECTLY. Be very sure you understand what you are doing. See
[this issue](http://github.com/bulletmark/edid-rw/issues/5) for an
example of what can happen.*

You may have to disable output to the display before you can write the
EDID.
Expand Down Expand Up @@ -33,20 +35,23 @@ Run with `-h` switch to see usage and optional arguments:

./edid-rw -h

Fetch and decode display 0 EDID data:
Fetch and decode display address 0 EDID data:

sudo ./edid-rw 0 | edid-decode

Fetch and decode display 1 EDID data:
Fetch and decode display address 1 EDID data:

sudo ./edid-rw 1 | edid-decode

Capture display 0 EDID data, edit it, and write it back to device. Use
`!Gxxd [-r]` within vim to read, edit, and write binary file. See `:h xxd`
within vim help. You should set the checksum (last) byte correctly
although edit-rw will calculate and set the checksum itself if you
include the `-f (--fix)` switch. edid-rw will always validate the
checksum and will not write an invalid EDID:
Capture display address 0 EDID data, edit it, and write it back to
device. Use `!Gxxd [-r]` within vim to read, edit, and write binary
file. See `:h xxd` within vim help. You should set the checksum (last)
byte correctly although edit-rw will calculate and set the checksum
itself if you include the `-f (--fix)` switch. edid-rw will always
validate the checksum and will not write an invalid EDID:

*WARNING - Be sure to triple check the EDID address you are about to
write!*

sudo ./edid-rw 0 >edid.bin
vim -b edid.bin # Then use xxd within vim, see ":h xxd" in vim
Expand Down

0 comments on commit 3215e49

Please sign in to comment.