Skip to content

Commit ddb0e61

Browse files
author
Michael Bikovitsky
committed
Documentation update.
1 parent 9173720 commit ddb0e61

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,31 +14,33 @@ an image resizer.
1414

1515
Usage
1616
------
17-
bftools \<operation\> \<args\>
17+
bftools <operation> <args>
1818

1919
This utility __saves__ images in PNG format, so watch your extensions.
2020
This utility __reads__ images in all formats supported by the .NET framework.
2121

22-
__Note: By default, this utility outputs to stdout.__
22+
__Note: By default, this utility outputs to `stdout`. *Piping is supported!*__
23+
24+
__Note: The `-` character stands for `stdin`.__
2325

2426
### Encoding
25-
bftools encode --lang brainfuck --file \<file\> [--output \<output file\>] <br>
26-
bftools encode --lang brainloller --file \<file\> --width \<width\> [--output \<output image\>] <br>
27-
bftools encode --lang braincopter --file \<file\> --original \<original image> [--output \<output image\>]
27+
bftools encode brainfuck <file | -> [--output <output file>]
28+
bftools encode brainloller <file | -> --width <width> [--output <output image>]
29+
bftools encode braincopter <file | -> --original <original image> [--output <output image>]
2830

2931
### Decoding
30-
bftools decode --lang brainloller --image \<input image\> [--output \<output image\>] <br>
31-
bftools decode --lang braincopter --image \<input image\> [--output \<output image\>]
32+
bftools decode brainloller <image | -> [--output <output image>]
33+
bftools decode braincopter <image | -> [--output <output image>]
3234

3335
### Running
34-
bftools run --file \<input file\>
36+
bftools run <program | ->
3537

3638
### Image operations
37-
bftools enlarge --image \<input image\> --factor \<factor\> [--output \<output image\>] <br>
38-
bftools reduce --image \<input image\> --factor \<factor\> [--output \<output image\>]
39+
bftools enlarge <image | -> <factor> [--output <output image>]
40+
bftools reduce <image | -> <factor> [--output <output image>]
3941

4042
### Getting help
41-
bftools help
43+
bftools help
4244

4345
Further reading
4446
----------------

0 commit comments

Comments
 (0)