diff options
| author | John Fultz <jfultz@wolfram.com> | 2015-08-20 05:38:05 -0500 |
|---|---|---|
| committer | John Fultz <jfultz@wolfram.com> | 2015-08-20 05:38:05 -0500 |
| commit | 06b0b048147df0387001f8c4bf8f52851d722240 (patch) | |
| tree | 6f6466018b2b15756000d0561c65f225e2e81cf7 /README.md | |
| parent | d912747a68c38baa1d19e07067d8c691f29f8198 (diff) | |
Update readme.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 26 insertions, 4 deletions
@@ -1,4 +1,4 @@ -Quackle +Quackle  ======= [](http://travis-ci.org/quackle/quackle) @@ -7,11 +7,33 @@ 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. +Building Quackle: +----------------- +Quackle is built and tested with the latest release of Qt 4.8. It does not presently build against Qt 5. +See README.MacOS and README.Windows for platform-specific instructions. Generally: + +Clone the repo or download the tarball and untar. Use qmake to build quackle.pro and quackleio/quackleio.pro: + + qmake quackle.pro && make + cd quackleio && qmake && make && cd .. + +Finally, build the main binary. -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 ./release/Quackle to start the program. + cd quacker && qmake + +The binary will build as 'Quackle'. It might be found in the quacker directory or in the release subdirectory. + + +File organization: +------------------ +* quackle/ - libquackle sources. libquackle is the engine, and can be linked to any convenient interface. It does not use Qt. +* quackle/quackleio/ - I/O library for Quackle. Implements stuff for accessing dictionaries, serializing GCG files, etc. Also, command-line option handling. This does have some modest dependencies on Qt. +* quackle/quacker/ - code for full Quackle UI. Written in Qt, and requires libquackleio and libquackle. +* quackle/makeminidawg/ - standalone console program for building Quackle dictionaries. +* quackle/makegaddag/ - standalone console program for building gaddag files. +* quackle/data/ - lexicons, strategy files, and alphabet resources for Quackle. +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. -See README.MacOS and README.Windows for platform-specific instructions. olaughlin@gmail.com jasonkatzbrown@gmail.edu |