Skip to content

Commit

Permalink
Update installation documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bennylope committed Oct 24, 2014
1 parent b520f5e commit bad3688
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ django-organizations
====================

:Info: Groups and multi-user account management
:Version: 0.4.1
:Version: 0.4.2
:Author: Ben Lopatin (http://benlopatin.com)

.. image:: https://secure.travis-ci.org/bennylope/django-organizations.svg?branch=master
Expand Down Expand Up @@ -31,7 +31,6 @@ functionality beyond the individual user.
* Invitation and registration functionality works out of the box for many
situations and can be extended as need to fit specific requirements.
* Start with the base models or use your own for greater customization.


Documentation is on `Read the Docs
<http://django-organizations.readthedocs.org/en/latest/index.html>`_
Expand All @@ -54,6 +53,13 @@ You should install by downloading the source and running::
Django versions included an older version of `six` with which Django
Organizations is incompatible.

.. note::

If you are using South you must use 1.0. Django Organizations is
incompatible with earlier versions of South, as this project uses the
`south_migrations` folder for schema migrations in order to maintain Django
1.7 compatability.

Configuring
-----------

Expand Down Expand Up @@ -206,5 +212,5 @@ Etc.
License
=======

Anyone is free to use or modify this software under ther terms of the BSD
Anyone is free to use or modify this software under the terms of the BSD
license.
7 changes: 7 additions & 0 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,13 @@ First add the application to your Python path. The easiest way is to use
Django versions included an older version of `six` with which Django
Organizations is incompatible.

.. note::

If you are using South you must use 1.0. Django Organizations is
incompatible with earlier versions of South, as this project uses the
`south_migrations` folder for schema migrations in order to maintain Django
1.7 compatability.

Ensure that you have a user system in place to connect to your organizations.
django-organizations will work with the `django.contrib.auth` package or custom
user models (see configuration below).
Expand Down

0 comments on commit bad3688

Please sign in to comment.