From ddcfb9b1742aa87685f2b7ae514ccecf77002753 Mon Sep 17 00:00:00 2001 From: Joey Hines Date: Sat, 9 Apr 2022 13:51:30 -0600 Subject: [PATCH] Updated README.md [CI SKIP] --- README.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d73a29b..69fbd84 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,23 @@ # Formaty A simple configurable binary data parser. Data structures are described using TOML files. -## Example -Checkout the formats described in [formats](./formats) +## Formats +All formats in [formats](./formats) are included in the `formaty` binary. See [formats.md](./formats/formats.md) for +more info. +## Example ```bash -./formaty formats/ccsds.toml ccsds "[0xe0, 0xa1, 0xc0, 0x00, 0x05, 0x00, 0x01, 0x02, 0x03, 0x04, 0x05]" +./formaty ccsds "[0xe0, 0xa1, 0xc0, 0x00, 0x00, 0x05, 0x01, 0x02, 0x03, 0x04, 0x05]" ```` Output: ``` Version Number: 0 -Packet Type: 0 +Packet Type: 1 Secondary Header Flag: 0 -APID: 1295 -Sequency Flags: 0 -Packet Sequence Count: 48 +APID: 0x200 +Sequence Flags: 3 +Packet Sequence Count: 0 Data Length: 5 Data: [1, 2, 3, 4, 5] ``` @@ -26,17 +28,18 @@ Formaty 0.1.0 Arbitrary Binary Data Formatting USAGE: - formaty [data]... + formaty [OPTIONS] [data]... FLAGS: -h, --help Prints help information -V, --version Prints version information +OPTIONS: + -c, --config Path to the format config + ARGS: - Path to the format config Format to parse data as ... Raw data - ``` ## License