Updated README.md [CI SKIP]
This commit is contained in:
		
							parent
							
								
									492e4dfc52
								
							
						
					
					
						commit
						79f8ae641d
					
				
							
								
								
									
										25
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										25
									
								
								README.md
									
									
									
									
									
								
							| @ -1,21 +1,23 @@ | ||||
| # Formaty | ||||
| A simple configurable binary data parser. Data structures are described using TOML files.  | ||||
| A simple configurable binary data parser. Data structures are described using TOML files. | ||||
| 
 | ||||
| ## Formats | ||||
| All formats in [formats](./formats) are included in the `formaty` binary. See [formats.md](./formats/formats.md) for | ||||
| more info. | ||||
| 
 | ||||
| ## Example | ||||
| Checkout the formats described in [formats](./formats) | ||||
| 
 | ||||
| ```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 <config> <format> [data]... | ||||
|     formaty [OPTIONS] <format> [data]... | ||||
| 
 | ||||
| FLAGS: | ||||
|     -h, --help       Prints help information | ||||
|     -V, --version    Prints version information | ||||
| 
 | ||||
| OPTIONS: | ||||
|     -c, --config <config>    Path to the format config | ||||
| 
 | ||||
| ARGS: | ||||
|     <config>     Path to the format config | ||||
|     <format>     Format to parse data as | ||||
|     <data>...    Raw data | ||||
| 
 | ||||
| ``` | ||||
| 
 | ||||
| ## License | ||||
|  | ||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user