FriiDump 0.5.3.16 candidate: add native reports and Linux Xbox support

[friidump.git] / README

diff --git a/README b/README
index a481527d4d38da594015dea1f206887da49abb6f..a983057b0e4656e4747f66236c49ca462793b167 100644 (file)
--- a/README
+++ b/README
@@ -7,6 +7,16 @@ FF 08 01 vendor lock-state path, redump-style metadata output, optional
 XISO output, and a convenient forced-DVD mode (`-D` / `--dvd`). See
 docs/XBOX.md for Xbox-specific details.
 
 XISO output, and a convenient forced-DVD mode (`-D` / `--dvd`). See
 docs/XBOX.md for Xbox-specific details.
 

+FriiDump 0.5.3.16-pf1 also creates native compatibility evidence reports
+by default for normal dump invocations using the `friidump-test-result.v1`
+contract. The default report is written beside the final FriiDump log and
+derives its filename from that log. `--report-json` overrides the pathname,
+`--report-dir` overrides the destination directory, and
+`--firmware-modified <note>` records modified firmware; omission assumes
+stock firmware. Reports are atomic, preserve exact live drive/firmware
+identity, and distinguish complete, partial, failed, cancelled, diagnostic,
+and resumed runs. See `docs/NATIVE_REPORTS.md`.
+

 FriiDump is a program that lets you dump Nintendo Wii and GameCube disc from
 your computer, without using original Nintendo hardware. It basically performs
 the same functions as the famous "RawDump" program, but with a big difference,
 FriiDump is a program that lets you dump Nintendo Wii and GameCube disc from
 your computer, without using original Nintendo hardware. It basically performs
 the same functions as the famous "RawDump" program, but with a big difference,


@@ -176,6 +186,11 @@ or a command-prompt under Windows. The basic usage is as follows:
 
 friidump -d <drive> -a
 
 
 friidump -d <drive> -a
 

+A native compatibility report is created automatically for the same run.
+To place it in a different directory:
+
+friidump -d <drive> -a --report-dir reports
+

 For a plain DVD-ROM dump from any readable drive, use `-D` / `--dvd` or the
 numeric equivalent `-T 3`:
 
 For a plain DVD-ROM dump from any readable drive, use `-D` / `--dvd` or the
 numeric equivalent `-T 3`: