]> git.xolatile.top Git - emil-bake.git/commitdiff
balanced
authorEmil Williams <emilemilemil@cock.li>
Sun, 14 Apr 2024 05:34:32 +0000 (05:34 +0000)
committerEmil Williams <emilemilemil@cock.li>
Sun, 14 Apr 2024 05:34:32 +0000 (05:34 +0000)
README

diff --git a/README b/README
index 4b92f115a22a59fc7a33442e295fb3b8e6d739de..5c6a7609c0c7f924289e7f008fa03fcb3b1ea568 100644 (file)
--- a/README
+++ b/README
@@ -33,21 +33,22 @@ files. See the file's content for more details regarding the installation.
 
 Macro provides various descriptive factors about the current context:
 
- @FILENAME : Filename of the baked file (abc.x.txt) @SHORT : Shortened version
- of the Filename (^-> abc.x) @ARGS : the remaining arguments to Bake
+ @FILENAME : Filename of the baked file (abc.x.txt)
+ @SHORT : Shortened version of the Filename (^-> abc.x)
+ @ARGS : the remaining arguments to Bake
 
 $@, $*, $+, are respectively mapped to @FILENAME, @SHORT, and @ARGS.  They have
 been partially deprecated, however they'll never be removed, use them if you'd
 like.
 
-They are most useful for a template command, such as: @BAKE cc @FILENAME -o
- @SHORT @ARGS
+They are most useful for a general template command, such as:
+
+@BAKE cc @FILENAME -o @{@SHORT} @ARGS
 
 Backslash, while otherwise ignored, will be respected at the end of the line to
 concatenate lines together or if added to before any of listed macros will yield
 the unfettered text. \SPECIAL_NAME will result in SPECIAL_NAME in the executed
-shell command. Backslashes are applicable to all symbols used by Bake, they are
-ignored otherwise.
+shell command. Backslashes are applicable to all symbols used by Bake.
 
 --- Expunge Extension ---
 
@@ -71,12 +72,13 @@ This feature was suggested by the original author of Shake, blame him for this.
 
 --- Options ---
 
-Options must come before the filename, and may be merged together, such as -xn.
+Options must come before the filename, and may be merged together, such as -cxn.
 
- -v, --version: display versioning and licensing information.  h, --help:
- -display the help message, similarly to empty input.  n, --dry-run: DRYRUN,
- -does NOT run anything!  x, --expunge: See above Expunge Extension section.  c,
- ---color: Disables color for a clean output.
+ -v, --version: Display versioning and licensing information.
+ -h,    --help: Display the help message, similarly to empty input.
+ -n, --dry-run: DRYRUN: does NOT run anything!
+ -x, --expunge: See above Expunge Extension section.
+ -c,   --color: Disables color for a clean output.
 
 --- Shake ---