From a3aaecba97cddc1737ac238334efdc735d3f42cd Mon Sep 17 00:00:00 2001
From: Abraham Martin <amc203@cam.ac.uk>
Date: Thu, 20 Dec 2018 12:48:02 +0100
Subject: [PATCH] Update READMEs
---
README.md | 13 ++++++++++++-
README.rst | 13 +++++++++++++
2 files changed, 25 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index a1e1212..eedcadf 100644
--- a/README.md
+++ b/README.md
@@ -149,4 +149,15 @@ class MyModelAdmin(ModelAdmin):
return get_institution_name_by_id(obj.institution_id, self.all_institutions)
institution.admin_order_field = 'institution_id'
-```
\ No newline at end of file
+```
+
+# Developing
+
+## Run tests
+
+Tox is configured to run on a container with a matrix execution of different versions of python and django combined.
+It will also show the coverage and any possible PEP8 violations.
+
+```shell
+$ docker-compose up --build tox
+```
diff --git a/README.rst b/README.rst
index 306848a..15ade7b 100644
--- a/README.rst
+++ b/README.rst
@@ -187,3 +187,16 @@ the name instead of the code in the admin interface
institution.admin_order_field = 'institution_id'
+
+Developing
+==========
+
+Run tests
+---------
+
+Tox is configured to run on a container with a matrix execution of different versions of python and django combined.
+It will also show the coverage and any possible PEP8 violations.
+
+.. code:: shell
+
+ $ docker-compose up --build tox
--
GitLab