summary refs log tree commit diff homepage
path: root/docs/README.md
diff options
context:
space:
mode:
authorNguyễn Gia Phong <vn.mcsinyx@gmail.com>2018-08-06 21:59:00 +0700
committerNguyễn Gia Phong <vn.mcsinyx@gmail.com>2018-08-06 21:59:00 +0700
commit6d2f6d6ad3348570664d84c188560cb9ae4aac82 (patch)
tree0aff0f0222085624761e6a702a421989df14342b /docs/README.md
parentd6dfd431588624510574c2386a563af890c4adc1 (diff)
downloadbrutalmaze-6d2f6d6ad3348570664d84c188560cb9ae4aac82.tar.gz
Add further description on game recording
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/README.md b/docs/README.md
index f55a93e..dadc38f 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,3 +1,7 @@
 # Brutal Maze record player
 
-Hosted by Github Pages: https://McSinyx.github.io/brutalmaze/
+Either game played by human or client script can be recorded to JSON format.
+This can be enabled by setting the output directory to a non-empty string via
+command-line option `--record-dir` or `Directory` in configuration file's
+`Record` section.  Recordings can be played on
+[the repo's Github Page](https://McSinyx.github.io/brutalmaze/).