update readme

This commit is contained in:
Squibid 2025-11-05 13:30:03 -05:00
parent a68e6e67b1
commit 3baa173c3b
Signed by: squibid
GPG key ID: BECE5684D3C4005D

View file

@ -1,2 +1,28 @@
# ZMOTD - zig motd # ZMOTD - zig motd
Literally just a motd setter for my servers. Literally just a motd setter for my servers.
All this program does it gather system information and prints it as pretty as
possible. It's configured in toml and the default layout is as follows:
```toml
entries = [
{ m = "hostname", f = "fig" }, # m for module name, f for format name
{ m = "distro" },
{ m = "kernel" },
{ m = "load" },
{ m = "uptime" },
]
```
which looks like this:
```
__ ___ _ ___ ___ ___ _ __
\ V / '_/ _ \/ _ \/ _ \ ' \
\_/|_| \___/\___/\___/_|_|_|
Distro: Void
Kernel: 6.16.6_1
Load: 0.13, 0.29, 0.49
Uptime: 1 week, 6 days, 23 hours, 26 minutes
```
To actually set your motd just write the output to `/etc/motd` or wherever your
system stores it.