summaryrefslogtreecommitdiff
path: root/util/chromeos/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'util/chromeos/README.md')
-rw-r--r--util/chromeos/README.md25
1 files changed, 13 insertions, 12 deletions
diff --git a/util/chromeos/README.md b/util/chromeos/README.md
index 3c3d721a3c..7a3897d8a0 100644
--- a/util/chromeos/README.md
+++ b/util/chromeos/README.md
@@ -1,27 +1,28 @@
-Chrome OS binary extraction
-===========================
+# Chrome OS Scripts
-These scripts can be used to extract System Agent reference code
-and other blobs (e.g. mrc.bin, refcode, VGA option roms) from a
-Chrome OS recovery image.
+These scripts can be used to access or generate Chrome OS resources, for example
+to extract System Agent reference code and other blobs (e.g. `mrc.bin`, refcode,
+VGA option roms) from a Chrome OS recovery image.
-crosfirmware.sh
----------------
+## crosfirmware.sh
-crosfirmware.sh downloads a Chrome OS recovery image from the recovery
+`crosfirmware.sh` downloads a Chrome OS recovery image from the recovery
image server, unpacks it, extracts the firmware update shell archive,
extracts the firmware images from the shell archive.
To download all Chrome OS firmware images, run
+```
$ ./crosfirmware.sh
+```
To download, e.g. the Panther firmware image, run
+```
$ ./crosfirmware.sh panther
+```
-extract_blobs.sh
-----------------
+## extract_blobs.sh
-extract_blobs.sh extracts the blobs from a Chrome OS firmware image.
+`extract_blobs.sh` extracts the blobs from a Chrome OS firmware image.
Right now it will produce the ME firmware blob, IFD, VGA option rom,
-and mrc.bin
+and `mrc.bin`.