aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.md
diff options
context:
space:
mode:
authorTom Christie2012-09-01 21:35:30 +0100
committerTom Christie2012-09-01 21:35:30 +0100
commitb9177f740bf91e6e39abd0991f030d592b7ca6e5 (patch)
treebeeae22e34a85459528f73741dc58684cbf12319 /docs/index.md
parent5d21e42206938f840cbaeb08829d74644e84fc5d (diff)
downloaddjango-rest-framework-b9177f740bf91e6e39abd0991f030d592b7ca6e5.tar.bz2
Docs tweak for first docs deployment
Diffstat (limited to 'docs/index.md')
-rw-r--r--docs/index.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/docs/index.md b/docs/index.md
index 340c6734..31bb9deb 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -21,8 +21,6 @@ The following packages are optional:
* [Markdown][markdown] (2.1.0+) - Markdown support for the self describing API.
* [PyYAML][yaml] (3.10+) - YAML content type support.
-If you're installing using `pip`, all requirements and optional packages will be installed by default.
-
## Installation
**WARNING: These instructions will only become valid once this becomes the master version**
@@ -89,6 +87,18 @@ General guides to using REST framework.
* [Form overloading][formoverloading]
* [Credits][credits]
+## Development
+
+If you want to work on REST framework itself, clone the repository, then...
+
+Build the docs:
+
+ ./mkdocs.py
+
+Run the tests:
+
+ ./djangorestframework/runtests/runtests.py
+
## License
Copyright (c) 2011-2012, Tom Christie