summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoremkael <emkael@tlen.pl>2016-11-25 17:59:36 +0100
committeremkael <emkael@tlen.pl>2016-11-25 17:59:36 +0100
commit9dfdf363fabc519ffcfddd7cca080d9a20bfea2d (patch)
treec063a33cb09da6c96c0a06915746f79068f2cb88 /README.md
parent8e80cec14a4834ae2012959d61e473a2b430c6c4 (diff)
parent33dc53d44816b57d6f90dd656574b725294a1b49 (diff)
Merge branch 'requirements' into pyinstaller
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/README.md b/README.md
index 7113301..6b47751 100644
--- a/README.md
+++ b/README.md
@@ -5,18 +5,22 @@ 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
+* 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.
+For Linux, you can leave the default `engine` property, for Windows, you have to change it to `mysql.connector.django` to use Oracle connector.
+
# Usage
```