Minor changes
[matilda.git] / README.md
blob7e290ce312e9ff70904b08f66453d83dd9cb12fe
1 Matilda - Go/Igo/Wéiqí/Baduk playing software
2 ===
4 Matilda is a competitive computer Go playing engine and accompanying software.
5 Go is an ancient and beautiful strategy board game; you can read more about it
6 [here](http://senseis.xmp.net/?WhatIsGo).
8 Implementation-wise Matilda is a MCTS Mogo-like program. It is aimed at 64 bit
9 computers in shared memory, playing with Chinese rules via the Go Text Protocol.
10 It is versatile and optimized for speed in a lot of areas, though some changes
11 require a recompilation.
13 The relative strength of Matilda can be seen from playing on the
14 [CGOS](http://www.yss-aya.com/cgos/9x9/bayes.html). It is currently much
15 stronger in smaller boards than in larger ones.
17 **System Requirements**
19   - Linux, BSD, macOS or other POSIX 2004 compliant system
20   - C99 compiler suite with support for OpenMP 3.0 (like GCC or clang)
22 Before using read the INSTALL file carefully, and at least modify the file
23 src/inc/config.h to your taste.
25 **How to**
27 You can play with Matilda out of the box using a text interface. For a graphical
28 interface you can connect it with any GTP-speaking program that supports Chinese
29 rules, like [GoGui](http://gogui.sourceforge.net/).
30 Matilda also includes `matilda-twogtp` for self-play and benchmarking.
32 **Copyright**
34 All parts of Matilda are licensed as permissive free software, as described in
35 the file LICENSE that should accompany this document, except for the following
36 files. src/crc32.c, which was derived from another file, is distributed with the
37 same license as the original (public domain). The files contained in the
38 src/data/ directory may also be based on game records or other foreign files,
39 and may be in dubious licensing circumstances. For legal enquiries contact the
40 author of this software.
42 This project started as the practical component of a dissertation for the
43 obtention of a Masters Degree on Computer Science and Computer Engineering, from
44 the High Institute of Engineering of Lisbon, titled "Guiding Monte Carlo tree
45 searches with neural networks in the game of Go" (2016) by Gonçalo Mendes Ferreira.