summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README28
1 files changed, 27 insertions, 1 deletions
diff --git a/README b/README
index 9db608a..89c1e90 100644
--- a/README
+++ b/README
@@ -1 +1,27 @@
-Simple chess interface. Will probably support networking.
+Chess3
+---------------------------------------
+
+This is a simple chess game written in C. It is written
+without ncurses or curses.
+
+The game supports communication between processes
+through a duplexed filestream interface. See src/fscomch.
+
+Install
+---------------------------------------
+
+In the root directory of the repository, run `make` and
+`make install`. There are no dependencies.
+
+Play
+---------------------------------------
+
+Open two instances of the chess3 binary. The first will
+play white, the second will play black. Follow the on-screen
+instructions.
+
+License
+---------------------------------------
+
+This program is licensed under the MIT license. See
+`LICENSE` for more information.