Skeleton readme

1 files changed, 37 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0acbb9a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# ctak, ctaklm, and ct1986
+
+## Overview
+
+Details forthcoming, but at a glance:
+
+1. ctak is a C library for the game of Tak
+2. ctaklm is a line-mode interface to ctak and a computer opponent
+   (for 5x5)
+3. ct1986 is a similar interface, but designed for a Raspberry Pi Zero
+   running buildroot and displaying output on a character LCD.
+
+## Building for the native platform
+
+	PLATFORM=native make ctaklm
+
+## Building for the Raspberry Pi Zero
+
+Download and extract a recent version of buildroot into the working
+directory. Edit `BUILDROOT_DIR=buildroot-2020.11.1` in `Makefile` to
+point to the extracted directory.
+
+	make all
+
+## The computer opponent
+
+### Adversarial tree search implementation
+
+Details coming soon
+
+### The convolutional neural network cnn1986
+
+Details coming soon
+
+## License
+
+GPLv3+