Skip to content
This repository has been archived by the owner on Feb 7, 2019. It is now read-only.

Commit

Permalink
Precisions on how to embed and use CleanerVersion
Browse files Browse the repository at this point in the history
  • Loading branch information
maennel committed Sep 10, 2014
1 parent 58161b5 commit 6ccaa20
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

# Ignore IDE settings
.idea
*~

# Ignore Vagrant stuff
.vagrant/*
Expand Down
18 changes: 16 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------------------------
Expand Down

0 comments on commit 6ccaa20

Please sign in to comment.