summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichaƂ Zimniewicz <michzimny@users.noreply.github.com>2017-02-26 15:20:07 +0100
committerGitHub <noreply@github.com>2017-02-26 15:20:07 +0100
commit973d1cd652c8840a8e7c408182cfa79fb7183455 (patch)
tree82e383b7fd7db26284806137d2491d3f55ed713c /README.md
parent29b99d5e50af876141187c7bdf52d663f3ac0807 (diff)
parent73903fbae90953572241f96b0c25a89a5142abf2 (diff)
Merge pull request #8 from michzimny/requirements
Updated requirements and README
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
```