summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md10
-rw-r--r--requirements-linux.txt3
-rw-r--r--requirements-windows.txt2
-rw-r--r--requirements.txt2
4 files changed, 12 insertions, 5 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
```
diff --git a/requirements-linux.txt b/requirements-linux.txt
new file mode 100644
index 0000000..02377be
--- /dev/null
+++ b/requirements-linux.txt
@@ -0,0 +1,3 @@
+django
+mysqlclient
+readline
diff --git a/requirements-windows.txt b/requirements-windows.txt
new file mode 100644
index 0000000..48b847f
--- /dev/null
+++ b/requirements-windows.txt
@@ -0,0 +1,2 @@
+django
+pyreadline
diff --git a/requirements.txt b/requirements.txt
deleted file mode 100644
index b2ef732..0000000
--- a/requirements.txt
+++ /dev/null
@@ -1,2 +0,0 @@
-django==1.10
-mysqlclient==1.3.9