From 54fafc6a463399646b3b073b8cbff08cfd8abd25 Mon Sep 17 00:00:00 2001 From: Antoine Martin Date: Tue, 30 Mar 2021 22:57:27 +0200 Subject: [PATCH] README: mention cli flag for configuration --- README.org | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.org b/README.org index ce868c4..341d31b 100644 --- a/README.org +++ b/README.org @@ -73,8 +73,12 @@ variable. **** Extra remote configuration -=lohr= looks for a =lohr-config.yaml= file in its =LOHR_HOME= directory. The -=LOHR_CONFIG= variable takes precedence over looking into the state directory. +You can provide =lohr= with a YAML file containing additional configuration. You +can pass its path to the =--config= flag when launching =lohr=. If no +configuration is provided via a CLI flag, =lohr= will check the =LOHR_CONFIG= +environment variable. If the environment variable isn't set either, it will +check in =LOHR_HOME= is a =lohr-config.yaml= file exists, and try to load it. + This file takes the following format: #+begin_src yaml