From 61da1d3d986345894c524ccffd8445f2d28e60a6 Mon Sep 17 00:00:00 2001 From: Patrick Marsee Date: Fri, 25 Nov 2016 06:36:36 -1000 Subject: [PATCH] Add new file --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..17cf5ce --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +About This Project +------------------ + +This is a proof-of-concept project. There are two main files - spelling.py, and spelling_mp.py. Spelling.py uses a single computer; spelling_mp.py uses two computers on a LAN and requires packets.py to run. To run, simply run either of the main files in a Python 3.4 or newer console: Python3 spelling_mp.py (NOTE: Python 3 MMUST be used!) + +There are two goals of this project: 1) refine and balance the game mechanics in anticipation of a full game to use them, and 2) to develop packets.py with its QuickServer and QuickClient classes for turn-based LAN games. + +Reporting Issues +---------------- + +This is mostly intended for just me, developing this. However, if anyone does decide to submit bug reports, that can be done in the Issues tab. \ No newline at end of file