From da03afa75871a9b4ef4d56675717e98820af5f76 Mon Sep 17 00:00:00 2001 From: Marty Oehme Date: Tue, 1 Apr 2025 11:00:11 +0200 Subject: [PATCH] doc: Add goal for configuration --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ebac5f8..0dad066 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ feel free to do so by invoking it e.g. with `uvx git+https://git.martyoeh.me/Mar ## Configuration ```python -TASK_RC = os.getenv("TASKRC", "~/.config/task/taskrc") +TASK_RC = os.getenv("TASKRC", "~/.config/task/taskrc") # not implemented yet TASK_DATA_DIR = os.getenv("TASKDATA", "~/.local/share/task") TOPEN_DIR = os.getenv("TOPEN_DIR", "~/.local/share/task/notes") TOPEN_EXT = os.getenv("TOPEN_EXT", "md") @@ -57,5 +57,12 @@ TOPEN_EDITOR = os.getenv("EDITOR") or os.getenv("VISUAL", "nano") TOPEN_QUIET = os.getenv("TOPEN_QUIET", False) ``` -These are all environment variables taken, needs improved documentation. +These are all environment variables offered, needs improved documentation. + +Ultimately the goal would probably be to support reading from a taskwarrior 'taskrc' file, +which can then be optionally overwritten with env variables, +which can then be optionally overwritten with cli options. + +This is not fully implemented -- we support the above environment variables +and cli options, that's it.