Update README.

[plomrogue2-experiments] / README.md

diff --git a/README.md b/README.md
index 1a97be61c8b6f374a5980cc12adf5dd7c7b7ba38..b65f327805da2c2af0fbcdbd759c3c58714a7815 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,29 @@
-# plomrogue2-experiments
-preliminary study in mechanisms useful for a new PlomRogue engine
+Preliminary study on mechanisms useful for a new PlomRogue engine
+=================================================================
+
+The old PlomRogue engine in its mechanisms feels quite questionable to me now.
+I have some ideas for a new variant, but I must get acquainted with some
+relevant mechanics and their Python3 implementations first. So this code is just
+some playing around with these.
+
+A new PlomRogue engine should have:
+
+* server-client communication via sockets, on top of some internet protocol
+* the server should be capable of parallel computation
+* maybe use a different library for console interfaces than ncurses – how about
+  *urwid*?
+
+To play around with these mechanics, I create two executables to be run in
+dialogue:
+
+* `./client.py`
+* `./server.py`
+
+The following commands can be sent from client to server:
+
+* `QUIT` – closes the connection
+* `FIB` followed by positive integers (all tokens separated by ` `); for each
+  such integer n, calculates th nn-th Fibonacci number (this allows for testing
+  parallel CPU-heavy computation)
+
+See `./requirements.txt` for the dependencies.