From b6a78f2d24993ac67ddfc85747e0b4a700365f0a Mon Sep 17 00:00:00 2001 From: Xiphoseer Date: Tue, 18 Feb 2025 00:22:25 +0100 Subject: [PATCH 1/2] rename example to image-rider --- Cargo.toml | 2 +- examples/{parser.rs => image-rider.rs} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename examples/{parser.rs => image-rider.rs} (100%) diff --git a/Cargo.toml b/Cargo.toml index 1bddc40..fa247f0 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -39,4 +39,4 @@ pretty_assertions = "1.4" commodore = ["dep:forbidden-bands"] [[example]] -name="parser" +name="image-rider" diff --git a/examples/parser.rs b/examples/image-rider.rs similarity index 100% rename from examples/parser.rs rename to examples/image-rider.rs From ffdfbbfe89b74a92caae8429eccf26e6e1a6ee11 Mon Sep 17 00:00:00 2001 From: Xiphoseer Date: Tue, 18 Feb 2025 00:30:16 +0100 Subject: [PATCH 2/2] update README --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b254c73..75ece23 100644 --- a/README.md +++ b/README.md @@ -18,12 +18,12 @@ STX: An Atari ST STX Disk Image You can run the example application with the following command: -RUST_LOG=debug cargo run --example parser -- --input FILENAME +RUST_LOG=debug cargo run --example image-rider -- --input FILENAME To save track or sector image data (for example, the FAT filesystem embedded in a STX image): -RUST_LOG=debug cargo run --example parser -- --input INFILENAME --output OUTFILENAME +RUST_LOG=debug cargo run --example image-rider -- --input INFILENAME --output OUTFILENAME There are several sanity checks in the code to panic or exit the @@ -34,7 +34,13 @@ parsing failures. To disable checksum checks, pass the --ignore-checksums command line flag to the parser example: -RUST_LOG=debug cargo run --example parser -- --ignore-checksums --input FILENAME +RUST_LOG=debug cargo run --example image-rider -- --ignore-checksums --input FILENAME + +## Install locally + +To install the example application locally, run: + +cargo install --path . --examples # Development