summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 15 insertions, 2 deletions
diff --git a/README.md b/README.md
index b15a246..5e1c4c0 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,17 @@
-quackle
+Quackle
=======
-Quackle crossword game artificial intelligence and analysis tool
+Crossword game artificial intelligence and analysis tool.
+
+See LICENSE in this directory.
+
+In this directory is libquackle. Run qmake and then run make in this directory. Then cd to quackle/quackleio/, run qmake, and then run make.
+
+In quacker/ is a GUI that uses libquackle. It requires Qt 4. Run qmake then make in that directory to build it. Then, from within quackle/quacker/, run ./quacker to start the program.
+
+See README.MacOS and README.Windows for platform-specific instructions.
+
+olaughlin@gmail.com
+jasonkatzbrown@gmail.edu
+jfultz@wolfram.com
+matt.liberty@gmail.com