Add README, screenshots, tri-lingual wiki and wiki workflow (MIL-003)

README from the framework template, three terminal screenshots rendered by
script, wiki pages in English, Danish and Bahasa Malaysia, the publish-wiki
workflow, and the milestone links in the Project Plan.

Refs #13
Refs #14
Refs #15
Refs #16
Refs #17
Refs #18
This commit is contained in:
2026-10-17 15:41:15 +08:00
parent 5937dc2725
commit 457b84c6da
26 changed files with 523 additions and 4 deletions
+26
View File
@@ -0,0 +1,26 @@
# Usage
🌐 **English** · [Dansk](Usage-da) · [Bahasa Melayu](Usage-ms)
Print the letters instead of sending them. `--today` pretends it is another day:
```bash
python -m birthday_wisher --dry-run --today 2000-10-17
```
![A dry run](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/032-birthday-wisher/raw/branch/main/docs/images/dry-run.png)
Send the letters for today's birthdays (needs the [sender settings](Configuration)):
```bash
python -m birthday_wisher
```
| Option | Meaning |
| --- | --- |
| `--dry-run` | Print the e-mails instead of sending them |
| `--today YYYY-MM-DD` | Pretend today is this date |
| `--csv FILE` | Use another birthdays file |
| `--letters FOLDER` | Use another folder of letter templates |
Exit status 0 means success. Status 1 means the setup is wrong (missing file or setting) or a letter could not be sent. A birthday on 29 February is celebrated on 28 February in years that are not leap years.