Use Markdown for README.

[plomrogue2-experiments] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..daeabbe
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+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; for each such integer n, calculates the
+  n-th Fibonacci number (this allows for testing parallel CPU-heavy computation)
+
+See `./requirements.txt` for the dependencies.