aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/index.md14
-rw-r--r--docs/template.html1
2 files changed, 13 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
diff --git a/docs/template.html b/docs/template.html
index a8a0d741..e452ead7 100644
--- a/docs/template.html
+++ b/docs/template.html
@@ -102,6 +102,7 @@ margin-top: 5px;
<ul class="dropdown-menu">
<li><a href="{{ base_url }}/topics/csrf{{ suffix }}">Working with AJAX and CSRF</a></li>
<li><a href="{{ base_url }}/topics/formoverloading{{ suffix }}">Browser based PUT, PATCH and DELETE</a></li>
+ <li><a href="{{ base_url }}/topics/credits{{ suffix }}">Credits</a></li>
</ul>
</li>
</ul>