Merge pull request #112 from liamg/config-details-in-readme

Added more detail about config loading to README
This commit is contained in:
Liam Galvin 2018-12-05 12:58:40 +00:00 committed by GitHub
commit f89e60e130
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 8 additions and 2 deletions

View File

@ -82,7 +82,13 @@ As long as you have your `GOBIN` environment variable set up properly (and in `P
## 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.
@ -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.
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.
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]
cursor = "#e8dfd6"

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

BIN
hint.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.9 KiB

BIN
sixel.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB