morituri
morituri copied to clipboard
Configuration file documentation isn't clear about XDG, and non-XDG case
It's great that README.md has a section on the configuration file (https://github.com/thomasvs/morituri#configuration-file). But this documentation confused me. It didn't tell me:
- What does XDG mean? (A: it's an old acronym for the project now called freedesktop.org.)
- "The configuration file is stored according to XDG Base Directory Specification when possible." When is this "possible"? i.e., does morituri use the XDG Base Directory Specification on my system? (A: see morituri/common/directory.py, class Directory(), method getConfig(), and read code from there.)
- Where is
$XDG_CONFIG_HOME? (A: See the linked spec; default is$HOME/.config) - If morituri is not using the XDG Base Directory Specification on my system, where can I find the config file? (A:
~/.moriturirc) - I can't find this file in this location. Is something wrong? (A: I think morituri doesn't create it always; only when running certain commands. Not sure.)
- Tell me more about what the config file should look like. In particular, give me a template I can modify.
I intend to propose a pull request, with an improvement to the Configuration section of README.md, to address this issue.
It would be useful to have a template for the config file to know whether we can specify in the config file other parameters (i.e. file template, output directory and so on).