Minor notes on installation

This commit is contained in:
tom christie tom@tomchristie.com 2011-02-19 19:15:16 +00:00
parent ded60f5308
commit ec5eaa56c1

View File

@ -36,16 +36,23 @@ Installation & Setup
--------------------
The django-rest-framework project is hosted as a `mercurial repository on bitbucket <https://bitbucket.org/tomchristie/django-rest-framework>`_.
To get a local copy of the repository use mercurial::
To get a local copy of the repository either download the 0.1 release:
`django-rest-framework-0.1.tar.gz <https://bitbucket.org/tomchristie/django-rest-framework/downloads/django-rest-framework-0.1.tar.gz>`_
Or get the development source using mercurial::
hg clone https://bitbucket.org/tomchristie/django-rest-framework
To install Django REST framework to your ``site-packages`` directory run the ``setup.py`` script::
python setup.py install
To add django-rest-framework to a django project:
* Ensure that the ``djangorestframework`` directory is on your ``PYTHONPATH``.
* Add ``djangorestframework`` to your ``INSTALLED_APPS``.
That's normally all you'll need to do to get Django REST framework set up on a standard installation using the testserver.
* Ensure that the ``djangorestframework`` directory is on your ``PYTHONPATH``.
* Add ``djangorestframework`` to your ``INSTALLED_APPS``.
For more information take a look at the :ref:`setup` section.