summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJason Katz-Brown <jason@airbnb.com>2013-08-25 02:17:13 -0700
committerJason Katz-Brown <jason@airbnb.com>2013-08-25 02:17:13 -0700
commit9306cb60c32082c5403931de0823a9fd5daa196c (patch)
treeca1b6eb695fdf3f0c2294e92416b272164bae642 /README.md
parent8fb2c681cecc01b46b0f4ba02d5cc177c4747b1c (diff)
Initial git commit.
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