Skip to content

README.md: Fix formatting, make CLI parts distinguished #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sskras wants to merge 2 commits into
base: master
Choose a base branch
from
Open

README.md: Fix formatting, make CLI parts distinguished #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1d9e46
README.md: Fence the CLI parts into code blocks
sskras Jun 10, 2024
1a67480
README.md: Fix two cmd lines + one typo, bold the warning
sskras Jun 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,35 @@
rom-parser/rom-fixer
====================

```sh
$ git clone https://github.com/awilliam/rom-parser
$ cd rom-parser
$ make
```

To view ROM contents:

usage: rom-parser [ROM file]
```sh
$ ./rom-parser [ROM file]
```

This program does not have support for reading the ROM from pci-sysfs, please do this manually in advance, ex:

```sh
# cd /sys/bus/pci/devices/0000:01:00.0/
# echo 1 > rom
# cat rom > /tmp/image.rom
# echo 0 > rom
```

Pass the resulting image file as the argument to this program.

To modify ROM conents:
To modify ROM contents:

usage: rom-fixer [ROM file]
```sh
$ ./rom-fixer [ROM file]
```

Obtain ROM as above, program prompts for modifying ROM vendor and device IDs and invalid checksums.

IMPORTANT: rom-fixer will update the ROM file in place. Make a backup!
**IMPORTANT:** rom-fixer will update the ROM file in place. Make a backup!