Revision created by MOE tool push_codebase.
[gae.git] / python / lib / django-1.5 / README.rst
blobca2cd5e5a9e5ceb44f2f82bcd1c4d91794a963d0
1 Django is a high-level Python Web framework that encourages rapid development
2 and clean, pragmatic design. Thanks for checking it out.
4 All documentation is in the "docs" directory and online at
5 http://docs.djangoproject.com/en/dev/. If you're just getting started, here's
6 how we recommend you read the docs:
8 * First, read docs/intro/install.txt for instructions on installing Django.
10 * Next, work through the tutorials in order (docs/intro/tutorial01.txt,
11   docs/intro/tutorial02.txt, etc.).
13 * If you want to set up an actual deployment server, read
14   docs/howto/deployment/index.txt for instructions.
16 * You'll probably want to read through the topical guides (in docs/topics)
17   next; from there you can jump to the HOWTOs (in docs/howto) for specific
18   problems, and check out the reference (docs/ref) for gory details.
20 * See docs/README for instructions on building an HTML version of the docs.
22 Docs are updated rigorously. If you find any problems in the docs, or think they
23 should be clarified in any way, please take 30 seconds to fill out a ticket
24 here:
26 http://code.djangoproject.com/newticket
28 To get more help:
30 * Join the #django channel on irc.freenode.net. Lots of helpful people hang out
31   there. Read the archives at http://django-irc-logs.com/.
33 * Join the django-users mailing list, or read the archives, at
34   http://groups.google.com/group/django-users.
36 To contribute to Django:
38 * Check out http://www.djangoproject.com/community/ for information about
39   getting involved.
41 To run Django's test suite:
43 * Follow the instructions in the "Unit tests" section of
44   docs/internals/contributing/writing-code/unit-tests.txt, published online at
45   https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/unit-tests/#running-the-unit-tests