Add configuration section to README
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
Armin Friedl 2020-08-01 12:09:45 +02:00
parent 53a15e5a7f
commit 45a5d3372d
Signed by: armin
GPG key ID: 48C726EEE7FBCBC8

View file

@ -54,7 +54,7 @@ archive.tar.gz
-- file2.txt -- file2.txt
``` ```
`xwim` will create a folder `archive` in the current directory and extract the xwim will create a folder `archive` in the current directory and extract the
archive contents there. archive contents there.
# Supported formats # Supported formats
@ -108,6 +108,23 @@ meson compile
src/xwim test/archives/root.tar.gz src/xwim test/archives/root.tar.gz
``` ```
# Configure
xwim strives to just do the right thing out of the box. Consequently, it does
not require any configuration. If you are unhappy with the defaults you can
change them though.
## Changing the log level
Per default xwim chooses an appropriate log level according to your build type
(debug/release builds). If you want to change the verbosity you can set the
`XWIM_LOGLEVEL` environment variable. Valid levels are:
- trace
- debug
- info
- warning
- error
- critical
- off
# Contributing # Contributing
While xwim is still in incubator phase (i.e. before version 1.0) it's main While xwim is still in incubator phase (i.e. before version 1.0) it's main
repository is hosted on https://git.friedl.net/incubator/xwim with a mirror on repository is hosted on https://git.friedl.net/incubator/xwim with a mirror on