Flesh out README

2022-10-15 20:51:18 +01:00 · 2022-10-15 20:51:18 +01:00 · 2f7fe23ee9
commit 2f7fe23ee9
parent 726acba679
1 changed files with 13 additions and 2 deletions
--- a/README.md
+++ b/README.md
@ -1,5 +1,16 @@
 # Waffle Mole

-A small gopher server for POSIX systems, written in C99.
+A small gopher server for POSIX systems, written in C99. Drops
+priviledges with `pledge()` and `unveil()` on OpenBSD.

-To build: `make`
+## Building
+
+You'll need:
+- A C99 compiler
+- POSIX-compatible make
+
+Run `make` or `make waffle-mole`.
+
+## Limitations
+
+Only IPv6 is supported currently.