Initial commit

1 files changed, 32 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7113301
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# teamy-quick-lineup
+Command-line interface for line-up management in JFR Teamy.
+
+# Installation
+
+Prerequisites:
+
+* Python 3
+* pip
+* the prerequisites of mysqlclient-python - https://github.com/PyMySQL/mysqlclient-python
+
+```
+pip install -r requirements.txt
+```
+
+# Configuration
+
+Set MySQL settings in ql/settings.py.
+
+# Usage
+
+```
+python -m ql <round> <segment> [<start from table>]
+```
+
+For instance, to process round 3, segment 2, starting from table 1 run:
+
+```
+python -m ql 3 2 1
+```
+
+The script will iterate pair by pair in each match. It presents the currently assigned players and let you confirm them - pressing ENTER without any input - or change - providing player names (press TAB to autocomplete).