From 1eed50f6e58b66d77dbb2edf9f74bbb18f3aaae2 Mon Sep 17 00:00:00 2001 From: John Veness Date: Mon, 22 Jul 2024 13:37:48 +0100 Subject: [PATCH] Improve English in README --- README.md | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index a1d01b3..21d9133 100644 --- a/README.md +++ b/README.md @@ -3,23 +3,28 @@ Inspired by [wudump](https://github.com/FIX94/wudump) from FIX94. Features: -- Dump a Wii U Disc in WUD (uncompressed) or [WUX](https://gbatemp.net/threads/wii-u-image-wud-compression-tool.397901/) (loseless compression) format (including the game.key) -- Dump the GM Partitions (Game, Updates, DLCs) of an Wii U Disc as *.app,*.h3, .tmd, .tik, .cert files -- Supports dumping to SD (FAT32) and USB (NTFS only). When dumping to SD the files get slitted in 2 GiB parts. +- Dump a Wii U disc in WUD (uncompressed) or [WUX](https://gbatemp.net/threads/wii-u-image-wud-compression-tool.397901/) (loseless compression) format, including the game.key +- Dump the GM partitions (game, updates, DLC) of a Wii U disc as .app, .h3, .tmd, .tik, .cert files +- Supports dumping to SD (FAT32 only) and USB (NTFS only). When dumping to SD, the files get split into 2 GiB parts. Files will be dumped to `/wudump/[DISC-ID]/`. The disc id of a game can be found on the disc (e.g. WUP-P-ARDP for the EUR version of Super Mario 3D World). If WUDD fails to determine the disc id, "DISC" with a timestamp will be used instead. -If you want to create a partial dump (skipped sectors represented by 00 bytes) for discs with unreadable sectors, you can avoid the need to manually choose the skip sectors option on each error, by pressing Y at the error message to activate auto skip mode +If you want to create a partial dump (skipped sectors represented by 00 bytes) for discs with unreadable sectors, you can avoid the need to manually choose the skip sectors option on each error, by pressing Y at the error message to activate auto skip mode. -## How to merge splitted files +## How to merge split files -When you dump a .wux or .wud to the SD card it gets splitted into 2 GiB parts (FAT32 limitation). To merge them you can use the `copy` cmd tool. +When you dump a .wux or .wud to the SD card, it gets split into 2 GiB parts, due to a FAT32 limitation. To merge them: + +In Windows: -Example: `copy /b game.wux.part1 + game.wux.part2 game.wux` +In Linux and macOS: + +`cat game.wux.part1 game.wux.part2 > game.wux` + ## Dependencies -Requires an [Environment](https://github.com/wiiu-env/EnvironmentLoader) (e.g. Tiramisu or Aroma) with [MochaPayload](https://github.com/wiiu-env/MochaPayload) (Nightly-MochaPayload-20220725-155554 or newer) +Requires an [Environment](https://github.com/wiiu-env/EnvironmentLoader) (e.g. Tiramisu or Aroma) with [MochaPayload](https://github.com/wiiu-env/MochaPayload) (Nightly-MochaPayload-20220725-155554 or newer). - [wut](https://github.com/devkitPro/wut) - [libmocha](https://github.com/wiiu-env/libmocha) @@ -30,9 +35,9 @@ Requires an [Environment](https://github.com/wiiu-env/EnvironmentLoader) (e.g. T ### Logging Building via `make` only logs errors (via OSReport). To enable logging via the [LoggingModule](https://github.com/wiiu-env/LoggingModule) set `DEBUG` to `1` or `VERBOSE`. -`make` Logs errors only (via OSReport). -`make DEBUG=1` Enables information and error logging via [LoggingModule](https://github.com/wiiu-env/LoggingModule). -`make DEBUG=VERBOSE` Enables verbose information and error logging via [LoggingModule](https://github.com/wiiu-env/LoggingModule). +- `make` - Logs errors only (via OSReport). +- `make DEBUG=1` - Enables information and error logging via [LoggingModule](https://github.com/wiiu-env/LoggingModule). +- `make DEBUG=VERBOSE` - Enables verbose information and error logging via [LoggingModule](https://github.com/wiiu-env/LoggingModule). If the [LoggingModule](https://github.com/wiiu-env/LoggingModule) is not present, it'll fallback to UDP (Port 4405) and [CafeOS](https://github.com/wiiu-env/USBSerialLoggingModule) logging.