summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoremkael <emkael@tlen.pl>2016-11-25 17:38:18 +0100
committeremkael <emkael@tlen.pl>2016-11-25 17:38:18 +0100
commita4553708999b31d3fd4ec73f1fae31ffd712b91a (patch)
treea228c0c975ab500deab0cf8011d79bc002c2571f /README.md
parent0a27bbf9ce1f5b1a52bc62ff4d9e5c2f960b030c (diff)
Requirements files split per platform
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/README.md b/README.md
index 7113301..7f33a4b 100644
--- a/README.md
+++ b/README.md
@@ -5,14 +5,17 @@ Command-line interface for line-up management in JFR Teamy.
Prerequisites:
-* Python 3
+* Python 3 (on Windows <= 3.4 due to the availability of MySQL connector)
* pip
-* the prerequisites of mysqlclient-python - https://github.com/PyMySQL/mysqlclient-python
+* Linux environment: the prerequisites of mysqlclient-python - https://github.com/PyMySQL/mysqlclient-python
+* Windows environment: MySQL connector from Oracle, unavailable via PIP - https://dev.mysql.com/downloads/connector/python/
```
-pip install -r requirements.txt
+pip install -r requirements-PLATFORM.txt
```
+Where `PLATFORM` is either `windows` or `linux`.
+
# Configuration
Set MySQL settings in ql/settings.py.