aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 8 insertions, 11 deletions
diff --git a/README.md b/README.md
index ccd8f6c..3e6a01d 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# Imago
-A Go AI.
+An AI player of the game of Go.
## The project
@@ -10,22 +10,19 @@ Software Engineering of the University of Oviedo.
## Implementation
Imago is written in Python and the source code is inside the `imago` folder. The
-implementation is on an early stage and includes core game logic, a basic GTP
-engine and a placeholder AI function which plays on random empty vertices.
+implementation includes core game logic and a GTP engine able to play using
+either Monte Carlo Tree Search or a neural network trained on human matches.
A game of go with no AI can be played by running the `go.py` script. This is
useful to test the core game logic. The GTP engine can be started by the
`imagocli.py` script. Following the GTP specification, known commands can be
listed by entering `list_commands` on the GTP engine's interface.
-Tests are stored in the `tests` folder which as of now contains an example
-tests file. The tests can be run with the `test.sh` script which uses the
-Python package `coverage` to get coverage statistics.
+Tests are stored in the `tests` folder. The tests can be run with the `test.sh`
+script which uses the Python package `coverage` to get coverage statistics.
## Documentation
-The source code for a work in progress documentation is laid out inside the
-`doc` folder, including a Makefile to compile it. This documentation compiling
-process depends on `xelatex`, `biber`, `plantuml` and some `LaTeX` packages.
-This documentation is fully subject to change in any moment of development and
-it probably already contradicts the actual implementation.
+The source code for the documentation is laid out inside the `doc` folder,
+including a Makefile to compile it. The documentation compiling process depends
+on `xelatex`, `biber`, `plantuml` and some `LaTeX` packages.