aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index 750c513..11051c4 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,18 @@ make clean
The source repository URL, per-file Git base URL, and public email are configured once in `hugo.toml`.
+## Announcements
+
+Announcements are separate from journal entries and technical notes. The home page shows the latest three notices above RECENT, with the full archive at `/announcements/`. Announcements and journal entries share `/rss.xml`; RECENT continues to show only journal entries and notes.
+
+Create a notice with:
+
+```sh
+hugo new content --kind announcement announcements/your-announcement/index.md
+```
+
+Set the title and `created` publication date, keep `updated` current when editing, and write the notice in the generated Markdown file. The home page limit is configured by `params.announcementLimit` in `hugo.toml`.
+
## Licensing
Site code and templates are licensed under `GPL-3.0-or-later`; see `COPYING`.