about summary refs log tree commit diff homepage
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2017-07-30 02:57:00 -0400
committerJune McEnroe <june@causal.agency>2017-07-30 02:57:00 -0400
commit0d43b929c47cbfaef6d6f2726205ba9b5accac85 (patch)
tree28c8b9593bfb0f04e2b554e3f62d62bd14e925e5
parentInitial commit (diff)
downloadtorus-0d43b929c47cbfaef6d6f2726205ba9b5accac85.tar.gz
torus-0d43b929c47cbfaef6d6f2726205ba9b5accac85.zip
Add README
Diffstat (limited to '')
-rw-r--r--README10
1 files changed, 10 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..954c12c
--- /dev/null
+++ b/README
@@ -0,0 +1,10 @@
+Welcome to ascii.town!
+
+This software targets FreeBSD and Darwin.
+
+C source files are self-compiling, e.g. ./server.c.
+
+    torus.h        Shared structures and message protocol.
+    server.c       Maps torus.dat and listens on torus.sock.
+    client.c       Curses client.
+    help.c         Automated client which redraws a helpful banner.