aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README26
1 files changed, 26 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 00000000..3e5e2755
--- /dev/null
+++ b/README
@@ -0,0 +1,26 @@
+# To install django-rest-framework in a virtualenv environment...
+
+hg clone https://tomchristie@bitbucket.org/tomchristie/django-rest-framework
+cd django-rest-framework/
+virtualenv --no-site-packages --distribute --python=python2.6 env
+source ./env/bin/activate
+pip install -r requirements.txt # django, pip
+
+# To run the tests...
+
+cd testproject
+export PYTHONPATH=..
+python manage.py test djangorestframework
+
+# To run the examples...
+
+pip install -r examples/requirements.txt # pygments, httplib2, markdown
+cd examples
+export PYTHONPATH=..
+python manage.py syncdb
+python manage.py runserver
+
+# To build the documentation...
+
+pip install -r docs/requirements.txt # sphinx
+sphinx-build -c docs -b html -d docs/build docs html