Skip to content

Commit 01b2e24

Browse files
committed
Explain -o and some typos.
1 parent 81a4e9c commit 01b2e24

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,21 @@ The default extension is `efa` (short for: enhanced firmware archive). Other ext
1919

2020
Creating a new empty archive:
2121

22-
bin-archiver.exe `archive-name` -c `archive-version-string`
22+
> bin-archiver.exe `archive-name` `-o` `-c` `archive-version-string`
2323
24-
Please note that the archive version string is never encrypted, the files that you place into the archive may be.
24+
`-o`(overwrite) must always me added before `-c`(create archive). `-o` is optional, if the file exists then the bin-archiver won't do a thing.
2525

26-
Append an unencrpyted binary file to the archive:
26+
Please note that the `archive-version-string` is never encrypted, the files that you place into the archive may be.
2727

28-
> bin-archiver.exe `archive-name` -a `some-file` `some-file-version-string` `type-value`
28+
Append (`-a`) an unencrpyted binary file to the archive:
29+
30+
> bin-archiver.exe `archive-name` `-a` `some-file` `some-file-version-string` `type-value`
2931
3032
The `type-value` is an unsigned 32 bits value that you can use to identify the file that you added. In most situations you would define an enumerator that defines the values. You may add multiple `type-value` numbers if you would like to. This could be easy if you don't want to save the same binary multiple times. This approach gives you the freedom to eventually distribute another binary for one of the added type values in a later file.
3133

3234
So let's do an example. Let's say that I wanted to create an archive that contains a bootloader and a firmware. Together they form version 1.0. I would execute the following commands to make this happen:
3335

34-
> bin-archiver.exe "update.efa" -c "1.0"
36+
> bin-archiver.exe "update.efa" -o -c "1.0"
3537
3638
> bin-archiver.exe "update.efa" -a "bootloader.bin" "1.0" 1
3739
@@ -54,7 +56,7 @@ Appending a file also adds some checksums:
5456

5557
The checksums should be implemented just like they are in for example winzip. I used [this nice little tool](http://code.kliu.org/hashcheck/) to check the calculated values. It's an extension to windows explorer. It adds an extra tab in your file properties window.
5658

57-
Encrpytion
59+
Encryption
5860
----------
5961

6062
You can also append a file encrypted, just add the -k argument right behind the archive filename.

0 commit comments

Comments
 (0)