From 7ad7d00aafa1aa243f747e6a5f42cdd7fd99cbee Mon Sep 17 00:00:00 2001 From: Christian Semmler Date: Sat, 10 Jan 2026 21:44:55 +0100 Subject: [PATCH] Update README with installation and command examples Added installation instructions for Kaitai Struct Visualizer and updated ksdump command examples. --- docs/README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/README.md b/docs/README.md index 57d13cb8..be4bd72f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -9,6 +9,8 @@ Kaitai Struct allows you to define binary formats in a YAML-based `.ksy` file, w - Visualized interactively using the [Kaitai Struct Visualizer](https://github.com/kaitai-io/kaitai_struct_visualizer) - Dumped to human-readable formats using `ksdump` +image + ## Documented Formats | File | Extension | Description | @@ -18,6 +20,10 @@ Kaitai Struct allows you to define binary formats in a YAML-based `.ksy` file, w ## Using the Tools +### Installation + +See the [Kaitai Struct Visualizer installation instructions](https://github.com/kaitai-io/kaitai_struct_visualizer#installing) for setup details. + ### Kaitai Struct Visualizer (ksv) The [Kaitai Struct Visualizer](https://github.com/kaitai-io/kaitai_struct_visualizer) (`ksv`) provides an interactive terminal UI for exploring binary files. @@ -36,16 +42,12 @@ ksv samples/History.gsi history.ksy ```bash # Dump Players.gsi to JSON -ksdump samples/Players.gsi players.ksy +ksdump --format json samples/Players.gsi players.ksy # Dump History.gsi to YAML ksdump --format yaml samples/History.gsi history.ksy ``` -### Installation - -See the [Kaitai Struct Visualizer installation instructions](https://github.com/kaitai-io/kaitai_struct_visualizer#installing) for setup details. - ## Sample Files The [`samples/`](/docs/samples/) directory contains example save files for testing: