From 6ccaa20c82e682ea92d7a1eec3dc3712d6023541 Mon Sep 17 00:00:00 2001 From: Manuel Jeckelmann Date: Wed, 10 Sep 2014 23:28:46 +0200 Subject: [PATCH] Precisions on how to embed and use CleanerVersion --- .gitignore | 1 + README.rst | 18 ++++++++++++++++-- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index bfe6fe9..84236f2 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,7 @@ # Ignore IDE settings .idea +*~ # Ignore Vagrant stuff .vagrant/* diff --git a/README.rst b/README.rst index 8dbe23e..3beadc9 100644 --- a/README.rst +++ b/README.rst @@ -53,8 +53,22 @@ pip-installation):: pip install cleanerversion -Once you have your Django project in place, and the CleanerVersion app installed and registered, create your models as -follows. +Once you have your Django project in place, register CleanerVersion to the ``INSTALLED_APPS`` variable by adding the +``versions`` keyword as follows:: + + INSTALLED_APPS = ( + ... + 'versions', + ... + ) + +If you want to be sure, whether things work out correctly, run CleanerVersion's unittests from within your Django +project root:: + + python manage.py test versions + +If this terminates with a ``OK``, you're all set. Go on and create your models as follows. + A simple versionable model --------------------------