From 5706ba4b21a566cc7d42aeb26daafa2e02e7b271 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleksi=20Ha=CC=88kli?= Date: Wed, 13 Nov 2019 22:08:42 +0200 Subject: [PATCH] Fix code blocks in README --- README.rst | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index dbaae07..64e99cb 100644 --- a/README.rst +++ b/README.rst @@ -96,19 +96,25 @@ Requirements Installation ------------ -Download code, and run setup. +Download code, and run setup in one of the following ways depending on the method. -.. code-block:: +To install the production ready version from PyPI: - $ pip install django-defender +.. code-block:: bash - or + pip install django-defender - $ python setup.py install +To install the development version from source code after download: - or +.. code-block:: bash - $ pip install -e git+http://github.com/kencochran django-defender.git#egg=django_defender-dev + python setup.py install + +To install the master branch development version from the GitHub repository: + +.. code-block:: bash + + pip install -e git+http://github.com/kencochran django-defender.git#egg=django_defender-dev First of all, you must add this project to your list of ``INSTALLED_APPS`` in ``settings.py`` @@ -464,13 +470,13 @@ Running tests Tests can be run, after you clone the repository and having Django installed, like: -.. code-block:: +.. code-block:: bash - $ PYTHONPATH=$PYTHONPATH:$PWD django-admin.py test defender --settings=defender.test_settings + PYTHONPATH=$PYTHONPATH:$PWD django-admin.py test defender --settings=defender.test_settings With Code coverage: -.. code-block:: +.. code-block:: bash PYTHONPATH=$PYTHONPATH:$PWD coverage run --source=defender $(which django-admin.py) test defender --settings=defender.test_settings