diff --git a/README.md b/README.md index a1e1212050ed94e33578d86ddccf1224243a7b23..eedcadf9c1bbdc31c1c20f7bfcb40f641af552d3 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 306848a48980608fe72a3095ba31462ff1f3c1fd..15ade7bb617af407d40a5febfb4878a9244e4cab 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