summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichaƂ Klichowicz <emkael@tlen.pl>2018-01-07 16:01:49 +0100
committerGitHub <noreply@github.com>2018-01-07 16:01:49 +0100
commit627973c3c05484153abcdce6032d29fb8a839a38 (patch)
tree0d09bd242da042cbe5f1811338e69c9cb2110fad
parentd3a7e4e66ff224859441051f0c1f7fdc56caed86 (diff)
Update README.mdreadme-update
Fixes #17.
-rw-r--r--README.md44
1 files changed, 26 insertions, 18 deletions
diff --git a/README.md b/README.md
index be2225b..6c171d2 100644
--- a/README.md
+++ b/README.md
@@ -3,40 +3,48 @@ Command-line interface for line-up management in JFR Teamy.
# Installation
-Prerequisites:
-
-* Python 3 (on Windows <= 3.4 due to the availability of MySQL connector)
-* pip
-* Windows environment: MySQL connector from Oracle, unavailable via PIP - https://dev.mysql.com/downloads/connector/python/
-
-```
-pip install -r requirements-PLATFORM.txt
-```
-
-Where `PLATFORM` is either `windows` or `linux`.
-
-You can also download the pre-built EXE release.
+Download the pre-built bundle from one of the releases, unpack it and run the EXE file.
# Configuration
-Set MySQL settings in config.json.
+MySQL settings can be set in config.json, in application's runtime directory. Config file is created on first run if not present.
# Usage
```
-python quick_lineup.py [<round> <segment> [<start from table>]]
+quick_lineup.exe [<round> <segment> [<start from table>]]
```
For instance, to process round 3, segment 2, starting from table 1 run:
```
-python quick_lineup.py 3 2 1
+quick_lineup.exe 3 2 1
```
-If round and segment are missing, the script will ask for these values interactively.
+If round or segment are missing, the script will ask for these values interactively.
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).
-# Build process
+# Build requirements
+
+Prerequisites:
+
+* Python 3 (on Windows <= 3.4 due to the availability of MySQL connector)
+* pip
+* Windows environment: MySQL connector from Oracle, unavailable via PIP - https://dev.mysql.com/downloads/connector/python/
+
+```
+pip install -r requirements-PLATFORM.txt
+```
+
+Where `PLATFORM` is either `windows` or `linux`.
+
+In source form, the script may be invoked directly from Python interpreter:
+
+```
+python quick_lineup.py [<round> <segment> [<start from table>]]
+```
+
+# Build details
See: [BUILD.md](BUILD.md)