about summary refs log tree commit diff homepage
path: root/README
diff options
context:
space:
mode:
authorJune McEnroe <programble@gmail.com>2017-07-30 02:57:00 -0400
committerJune McEnroe <programble@gmail.com>2017-07-30 02:57:00 -0400
commitfc48a2250e111d43e040fcbc5902af73b8d748c5 (patch)
tree78c1e005c23b6404a22549a8cdd72760df9bce1d /README
parentInitial commit (diff)
downloadtorus-fc48a2250e111d43e040fcbc5902af73b8d748c5.tar.gz
torus-fc48a2250e111d43e040fcbc5902af73b8d748c5.zip
Add README
Diffstat (limited to 'README')
-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.