feat: add note about flow config to README.md

This commit is contained in:
CJ van den Berg 2024-02-20 20:13:59 +01:00
parent 64aab6048a
commit d4fefac181

View file

@ -8,7 +8,8 @@ Build with the provided zig wrapper:
./zig build -Doptimize=ReleaseFast ./zig build -Doptimize=ReleaseFast
``` ```
The zig wrapper just fetches a known good version of zig nightly and places it in the .cache directory. Or use your own version of zig. The zig wrapper just fetches a known good version of zig nightly and places it
in the .cache directory. Or use your own version of zig.
Run with: Run with:
```shell ```shell
@ -18,6 +19,9 @@ zig-out/bin/zat
Place it in your path for convinient access. You might want to strip it first. Place it in your path for convinient access. You might want to strip it first.
Supply files to highlight on the command line. Multiple files will be appended like with cat. If no files are on the command line zat will read from stdin. Override the language with --lang and select a different theme with --theme. Supply files to highlight on the command line. Multiple files will be appended
like with cat. If no files are on the command line zat will read from stdin.
Override the language with --lang and select a different theme with --theme.
The default theme will be read from ~/.config/flow/config.json if found.
See --help for full command line. See --help for full command line.