aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authortslil clingman <>2020-03-07 21:36:35 -0800
committertslil clingman <>2020-03-07 21:53:33 -0800
commit32cd2d480b6185e1d1382055297715c24bc95cb5 (patch)
tree0dc2f76986c612c45a3c39239ea2dc2c4cb3d70d /README.org
parente630098b578ace239663512dbde942bc9b111e96 (diff)
Actually it should be an MDrefactor
Diffstat (limited to 'README.org')
-rw-r--r--README.org46
1 files changed, 0 insertions, 46 deletions
diff --git a/README.org b/README.org
deleted file mode 100644
index 28593c5..0000000
--- a/README.org
+++ /dev/null
@@ -1,46 +0,0 @@
-* A TUI wrapper for local play of the game of Tak
-
-** Building
-
-Clone the repo, issue `cargo build` or and enjoy (?)
-
-** Usage
-
-Takwrap supports local play, undo, and starting variant and game
-exporting to PTN. See `takwrap -h` for options and details.
-
-Note in particular that `takwrap` supports the following alternate
-starting configurations, which are embedded in the exported PTN file
-as `[Variant XXX]`.
-
-- CPSn, counter-play start with n=1 is the default
- White places a black flat, then black places a white flat. This
- repeats n times, after which normal play resumes.
-
-- FCS, forbidden corner start
- CPS1 but white may not place the black flat in a corner
-
-- FES, forbidden edge start
- CPS1 but white may not place the black flat on an edge
-
-- TPS, two ply start
- White places two black flats, then black places a white flat and
- normal play resumes.
-
-- CZS, Czech start
- White places a black flat, then normal play resumes
-
-** Interfacing with engines
-
-Takwrap does not have computer opponents built in, but instead allows
-interfacing with external engine programmes with the `-e` parameter.
-It expects the name of an executable in the path which accepts the
-name of a file with a game-state in PTN, and which returns a single,
-valid move.
-
-See the file `wrap_taktician` for an example of utilising [[https://github.com/nelhage/taktician][Taktician]]
-for this purpose.
-
-Note that the engine is expected to respect the `[Variant XXX]` line
-in the PTN game-state, so expect breakage with anything but the
-default.