changeset 37:e87e121fe55c

Add README.md
author Lewin Bormann <lbo@spheniscida.de>
date Thu, 14 Mar 2019 17:44:57 +0100
parents 7b4e436a3115
children 4c0c86b1b64d
files README.md
diffstat 1 files changed, 25 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Thu Mar 14 17:44:57 2019 +0100
@@ -0,0 +1,25 @@
+# stex
+
+stex (**st**ock **ex**change) is another stock market simulator game like there have been many of before. This one
+featGures client/server mode in which several clients can play on identical, synchronous stock exchange data (randomly
+generated, just to be clear). More features are planned, but as of now, clients will already see the wealth of
+other players in the same group in their game window.
+
+# Dependencies
+
+These can be installed via `pip3` or your system's package manager:
+
+* `PyQt5` (>= 5.11)
+* `PyQtChart`
+* `pyzmq`
+* `arguments`
+
+# Usage
+
+Run `server/server.py` on one computer. Use `--help` to see options. Once started, it will produce a feed
+of arbitrarily many stocks, distributed as JSON objects in ZeroMQ messages.
+
+On any client, run `client/client.py`. You can again use `--help` for an overview of the available options. The client
+will store the information you enter in the client window so that you don't have to enter them every time. Note that
+the `Password` is not used anywhere so far -- it is meaningless. `Group` determines whose wealth numbers you see, so if
+you play with others you should choose the same group name here.