{"action":"created","issue":{"url":"https://api.github.com/repos/thomasvs/morituri/issues/71","labels_url":"https://api.github.com/repos/thomasvs/morituri/issues/71/labels{/name}","comments_url":"https://api.github.com/repos/thomasvs/morituri/issues/71/comments","events_url":"https://api.github.com/repos/thomasvs/morituri/issues/71/events","html_url":"https://github.com/thomasvs/morituri/issues/71","id":28775769,"number":71,"title":"Configuration file documentation isn't clear about XDG, and non-XDG case","user":{"login":"JDLH","id":1100216,"avatar_url":"https://avatars.githubusercontent.com/u/1100216?v=3","gravatar_id":"","url":"https://api.github.com/users/JDLH","html_url":"https://github.com/JDLH","followers_url":"https://api.github.com/users/JDLH/followers","following_url":"https://api.github.com/users/JDLH/following{/other_user}","gists_url":"https://api.github.com/users/JDLH/gists{/gist_id}","starred_url":"https://api.github.com/users/JDLH/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/JDLH/subscriptions","organizations_url":"https://api.github.com/users/JDLH/orgs","repos_url":"https://api.github.com/users/JDLH/repos","events_url":"https://api.github.com/users/JDLH/events{/privacy}","received_events_url":"https://api.github.com/users/JDLH/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2014-03-05T09:29:08Z","updated_at":"2015-04-22T09:18:23Z","closed_at":null,"body":"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:\r\n\r\n * What does XDG mean? (A: it's an old acronym for the project now called [freedesktop.org](https://en.wikipedia.org/wiki/Freedesktop.org).)\r\n * \"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.)\r\n * Where is `$XDG_CONFIG_HOME`? (A: See the linked spec; default is `$HOME/.config`)\r\n * If morituri is not using the XDG Base Directory Specification on my system, where can I find the config file? (A: `~/.moriturirc`)\r\n * 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.)\r\n * Tell me more about what the config file should look like. In particular, give me a template I can modify.\r\n\r\nI intend to propose a pull request, with an improvement to the *Configuration* section of README.md, to address this issue."},"comment":{"url":"https://api.github.com/repos/thomasvs/morituri/issues/comments/95087923","html_url":"https://github.com/thomasvs/morituri/issues/71#issuecomment-95087923","issue_url":"https://api.github.com/repos/thomasvs/morituri/issues/71","id":95087923,"user":{"login":"jeanpaulrh","id":4814843,"avatar_url":"https://avatars.githubusercontent.com/u/4814843?v=3","gravatar_id":"","url":"https://api.github.com/users/jeanpaulrh","html_url":"https://github.com/jeanpaulrh","followers_url":"https://api.github.com/users/jeanpaulrh/followers","following_url":"https://api.github.com/users/jeanpaulrh/following{/other_user}","gists_url":"https://api.github.com/users/jeanpaulrh/gists{/gist_id}","starred_url":"https://api.github.com/users/jeanpaulrh/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jeanpaulrh/subscriptions","organizations_url":"https://api.github.com/users/jeanpaulrh/orgs","repos_url":"https://api.github.com/users/jeanpaulrh/repos","events_url":"https://api.github.com/users/jeanpaulrh/events{/privacy}","received_events_url":"https://api.github.com/users/jeanpaulrh/received_events","type":"User","site_admin":false},"created_at":"2015-04-22T09:18:23Z","updated_at":"2015-04-22T09:18:23Z","body":"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). "}}