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
2026-10-17 15:41:15 +08:00
parent 5937dc2725
commit 457b84c6da
26 changed files with 523 additions and 4 deletions
@@ -0,0 +1,18 @@
+# Configuration
+
+🌐 **English** · [Dansk](Configuration-da) · [Bahasa Melayu](Configuration-ms)
+
+**People.** `birthdays.csv` has the header `name,email,year,month,day`. The file in the repository holds dummy data. Replace it with your own, and keep real addresses out of git.
+
+**Letters.** `letter_templates/letter_1.txt` to `letter_3.txt`. The text `[NAME]` is replaced by the person's name. One letter is chosen at random.
+
+**Sender.** Two environment variables:
+
+| Variable | Meaning |
+| --- | --- |
+| `GMAIL_ADDRESS` | Address the e-mail is sent from |
+| `GMAIL_TOKEN` | Gmail app password |
+
+`.env.example` shows the names. Never commit a real `.env`; it is ignored by git. The program reads the environment only and never prints the token.
+
+**Constants.** Server, port, subject and file names are in `src/birthday_wisher/constants.py`.