igneus / ordodo

generator of *ordo* (combined liturgical calendar for print)
MIT License
3 stars 1 forks source link

Output formatting #2

Open martindonat opened 6 years ago

martindonat commented 6 years ago

Hi,

I run ordodo for the first time and have some minor suggestions, which I will try to implement as a first exercise to get to know the code (and Ruby, I'm a Pythonist).

igneus commented 5 years ago

Hi, sorry for the delay - it's better to mention me if you open any further issues. (Tips on how to get notified somehow on new issues even without being mentioned are most welcome. Despite of quite a long history here, I can't call myself Github poweruser.)

the output filename should include the filename of the config file. Otherwise the file will be overwritten if you use different configs.

I'm OK with this. Later there should also be an option to specify the output filename if needed.

The std output should state the location of the output file at the end.

Sounds reasonable.

Maybe a log file would be nice (but I guess Ruby has some module for logging, I think I will leave that as it is).

There is a simple logging solution in the Ruby standard library. And there are, of course, plenty of third-party libraries. I don't see an urgent need for logging now, but should ordodo one day be widely used for "the real thing", logging would be really useful for remote troubleshooting.

igneus commented 5 years ago

Also, before eventually receiving the first pull-request for ordodo ever, I should finally pick a license. I have planned for some time to place this piece of software under the MIT license. Do you like/hate the idea?

martindonat commented 5 years ago

Puh, finally. Please have a look at my pull-request. Regarding the license: I like the idea of copyleft, but if you want to pick the easier MIT license I would be ok with it.

igneus commented 5 years ago

Thanks. MIT license adopted. I will comment on the PR shortly.

igneus commented 5 years ago

This need not be handled in the PR in progress, but is related to this issue, so I will note it here rather than there:

I think the "ordodo's main user interface is it's configuration file" philosophy (cf. README) should apply for specifying the output directory, too. It would make sense to support configuring path with placeholder(s), like ordo_{year} or my_custom_ordo_dir_{config_basename}_{year}