diff options
-rw-r--r-- | README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md index a8c7369..ec8b396 100644 --- a/README.md +++ b/README.md | |||
@@ -43,6 +43,40 @@ Or, for round-tripping ... | |||
43 | fucktrain FILE.bf | trainfuck | 43 | fucktrain FILE.bf | trainfuck |
44 | ``` | 44 | ``` |
45 | 45 | ||
46 | ## USAGE | ||
47 | |||
48 | `trainfuck -h`: | ||
49 | |||
50 | ``` | ||
51 | TRAINFUCK: CHOO CHOO | ||
52 | Usage: | ||
53 | trainfuck -h|--help | ||
54 | trainfuck [-w WIDTH] [FLAGS...] INPUTFILE [-o OUTPUTFILE] | ||
55 | |||
56 | Parameters: | ||
57 | INPUTFILE The trainfuck file to process. | ||
58 | If INPUTFILE ends in .tf or .trainfuck, it will be interpreted | ||
59 | as a TRAINFUCK file; if it ends in .bf or .brainfuck, it will | ||
60 | be interpreted as a BRAINFUCK file. Otherwise, the file will | ||
61 | be assumed to be the default filetype (trainfuck). | ||
62 | |||
63 | -w WIDTH Set the brainfuck output width (default: 42). | ||
64 | -o OUTPUTFILE Where to send transpiled brainfuck (default: /dev/stderr). | ||
65 | -- Stop processing arguments; interpret the rest as filenames | ||
66 | |||
67 | FLAGS: | ||
68 | -h, --help Show this help | ||
69 | -c, --comments Show comments (default) | ||
70 | -C, --no-comments Hide comments | ||
71 | -z, --compact Show "compact" comments (default) | ||
72 | -Z, --no-compact Show "wide" comments | ||
73 | -x, --execute Execute trainspiled brainfuck | ||
74 | -X, --no-execute Only trainspile, do not execute (default) | ||
75 | -t, --trainfuck Force TRAINFUCK mode: interpret files as trainfuck | ||
76 | -b, --brainfuck Force BRAINFUCK mode: interpret files as brainfuck | ||
77 | -q, --quiet Don't print any more than is necessary | ||
78 | ``` | ||
79 | |||
46 | ## INSTALL | 80 | ## INSTALL |
47 | 81 | ||
48 | ``` | 82 | ``` |