mirror of https://github.com/liamg/aminal.git
Added more detail about config loading to README
This commit is contained in:
parent
b960a679b8
commit
efb83433fa
10
README.md
10
README.md
|
@ -82,7 +82,13 @@ As long as you have your `GOBIN` environment variable set up properly (and in `P
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
Aminal looks for a config file in `~/.aminal.toml`, and will write one there the first time it runs, if it doesn't already exist.
|
Aminal looks for a config file in the following places, and stops when it finds one:
|
||||||
|
|
||||||
|
* `$XDG_CONFIG_HOME/aminal/config.toml`
|
||||||
|
* `$HOME/.config/aminal/config.toml`
|
||||||
|
* `$HOME/.aminal.toml`
|
||||||
|
|
||||||
|
It will write a config file to whichever of those directories exists (preferring the top of the list) the first time it runs, if one doesn't already exist.
|
||||||
|
|
||||||
You can ignore the config and use defaults by specifying `--ignore-config` as a CLI flag.
|
You can ignore the config and use defaults by specifying `--ignore-config` as a CLI flag.
|
||||||
|
|
||||||
|
@ -92,7 +98,7 @@ You can ignore the config and use defaults by specifying `--ignore-config` as a
|
||||||
debug = false # Enable debug logging to stdout. Defaults to false.
|
debug = false # Enable debug logging to stdout. Defaults to false.
|
||||||
slomo = false # Enable slow motion output mode, useful for debugging shells/terminal GUI apps etc. Defaults to false.
|
slomo = false # Enable slow motion output mode, useful for debugging shells/terminal GUI apps etc. Defaults to false.
|
||||||
shell = "/bin/bash" # The shell to run for the terminal session. Defaults to the users shell.
|
shell = "/bin/bash" # The shell to run for the terminal session. Defaults to the users shell.
|
||||||
search_url = "https://www.google.com/search?q=$QUERY" # The search engine to use for the "search selected text" action. Defaults to google. Set this to your own search url using $QUERY as the keywords to replcae when searching.
|
search_url = "https://www.google.com/search?q=$QUERY" # The search engine to use for the "search selected text" action. Defaults to google. Set this to your own search url using $QUERY as the keywords to replace when searching.
|
||||||
|
|
||||||
[colours]
|
[colours]
|
||||||
cursor = "#e8dfd6"
|
cursor = "#e8dfd6"
|
||||||
|
|
BIN
hint.colour.png
BIN
hint.colour.png
Binary file not shown.
Before Width: | Height: | Size: 12 KiB |
BIN
powerline.png
BIN
powerline.png
Binary file not shown.
Before Width: | Height: | Size: 5.9 KiB |
Loading…
Reference in New Issue