summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Peter <sharkdp@users.noreply.github.com>2018-11-11 11:07:38 +0100
committerDavid Peter <sharkdp@users.noreply.github.com>2018-11-11 11:07:55 +0100
commitd0ba5bcb32a8e1c73f808b5e67f6d419157e7eea (patch)
treecb270a1e9f79d2eb84538a6d2f1dbecf4da5bb26
parentf8d39d5624b6affc376ba2bc142841e8337aac65 (diff)
Wording
-rw-r--r--README.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/README.md b/README.md
index e83c8591..38b3f41c 100644
--- a/README.md
+++ b/README.md
@@ -323,21 +323,21 @@ If scrolling still doesn't work for you, you can try to pass the `-S` option in
### Configuration file
-`bat` can use a config file for options to cut down on command line flags, that you want to save for each run.
-
-#### Location
-
-The default location is OS/install location dependent to get the path for your operating system use `bat --config-file` to print out the location of the current config file path.
+`bat` can also be customized with a configuration file. The location of the file is dependent on you operating system. To get the default path for your system, call
+```
+bat --config-file
+```
-You can use the `$BAT_CONFIG_PATH` environment variable to point `bat` to a non-default location of the configuration file like so:
+Alternatively, you can use the `BAT_CONFIG_PATH` environment variable to point `bat` to a non-default location of the configuration file:
```bash
-export BAT_CONFIG_PATH=$HOME/code/setup/bat.conf
+export BAT_CONFIG_PATH="/path/to/bat.conf"
```
#### Format
-The config file is formatted just as you would pass arguments to the CLI. Here is an example:
+The configuration file is a simple list of command line arguments. Use `bat --help` to see a full list of possible options and values. In addition, you can add comments by prepending a line with the `#` character.
+Example configuration file:
```bash
# Set the theme to "TwoDark"
--theme="TwoDark"