diff options
Diffstat (limited to 'TODOs.md')
| -rw-r--r-- | TODOs.md | 23 |
1 files changed, 23 insertions, 0 deletions
@@ -1,5 +1,28 @@ # Tasks +## TODO Translate README.md and CHANGELOG.md {#task-7c5cd2aa-6d92-0423-bfa7-81f2e8436586} +- TODO in 2021-06-26 + +--- + +Unlike `doc/git-permalink.*.1.in` files, these two don't need to be commited into the repository. + +The reason why the manpages are is to lessen the requiment on the consumer whenthey're on the canonical `make && make install` path. +They can even `make check` before installing (or uninstalling), and all of those targets are specifically kept with minimal requirements, so that the user can build, test and install the software without requiring extra dependencies. +Due to that, the translated manpages are kept in the repository so that users don't need `po4a` or `gettext`. + +The same is not true for the `public` target. +This is meant for building the HTML pages of the website. +Even though all of the code that generates thoses pages live in the repository under `aux/`, `make public` isn't part of the canonical steps required for users to install software. + +Because of that, `{README,CHANGELOG}.{pt,fr,eo}.md` don't need to live in the repository, and can be generated on the fly under the `public` target. + +As with manpages, the actual file will be `README.en.md`, and `README.md` is a symlink to that. + +I should also add links to the translated versions on each translation. + +This should bring an accompanying change to `aux/workflow/assert-readme.sh` and `aux/workflow/assert-changelog.sh'. + ## DONE Remove hard coded `public/` path in some files under `aux/` {#task-f09dedb7-1b25-0b5e-2520-910a9aa32562} - DONE in 2021-06-22 |