Go to file
Julien Phalip 0133d66734 Removed a colloquialism ("and then some") from the documentation index page that would be confusing to non-native English speakers. 2012-09-10 17:27:50 -07:00
.tx Added a language mapping for Serbian (Latin) to the Transifex configuration file. 2012-03-23 02:31:12 +00:00
django Document and test 'type' usage in Widget attrs 2012-09-10 19:31:11 +02:00
docs Removed a colloquialism ("and then some") from the documentation index page that would be confusing to non-native English speakers. 2012-09-10 17:27:50 -07:00
extras Made more extensive usage of context managers with open. 2012-05-05 14:06:36 +02:00
scripts Fixed #11184 -- Made it possible to build RPMs with a non-default python executable. 2012-01-02 20:09:58 +00:00
tests Document and test 'type' usage in Widget attrs 2012-09-10 19:31:11 +02:00
.gitignore Fixed #14680 -- Added ignore files for Mercurial and Git. 2010-12-21 17:52:17 +00:00
.hgignore Fixed #14680 -- Added ignore files for Mercurial and Git. 2010-12-21 17:52:17 +00:00
AUTHORS Moved the admin inline JS to new JS files for cleanliness. 2012-09-08 15:09:37 -04:00
INSTALL Updated installation instructions. 2012-05-15 10:08:34 +02:00
LICENSE Updated LICENSE file to acknowledge individual copyrights as well (after 2008-08-09 14:40:51 +00:00
MANIFEST.in Fixed #18874 -- Updated new name of README.rst to auxiliary files 2012-08-29 21:25:02 +02:00
README.rst Fix bullet formatting for README.rst. 2012-04-28 21:20:39 +01:00
setup.cfg Fixed #18874 -- Updated new name of README.rst to auxiliary files 2012-08-29 21:25:02 +02:00
setup.py Fixed #18115 - added warning about overlaid install. 2012-05-21 17:28:58 -06:00

README.rst

Django is a high-level Python Web framework that encourages rapid development
and clean, pragmatic design. Thanks for checking it out.

All documentation is in the "docs" directory and online at
http://docs.djangoproject.com/en/dev/. If you're just getting started, here's
how we recommend you read the docs:

* First, read docs/intro/install.txt for instructions on installing Django.

* Next, work through the tutorials in order (docs/intro/tutorial01.txt,
  docs/intro/tutorial02.txt, etc.).

* If you want to set up an actual deployment server, read
  docs/howto/deployment/index.txt for instructions.

* You'll probably want to read through the topical guides (in docs/topics)
  next; from there you can jump to the HOWTOs (in docs/howto) for specific
  problems, and check out the reference (docs/ref) for gory details.

* See docs/README for instructions on building an HTML version of the docs.

Docs are updated rigorously. If you find any problems in the docs, or think they
should be clarified in any way, please take 30 seconds to fill out a ticket
here:

http://code.djangoproject.com/newticket

To get more help:

* Join the #django channel on irc.freenode.net. Lots of helpful people hang out
  there. Read the archives at http://django-irc-logs.com/.

* Join the django-users mailing list, or read the archives, at
  http://groups.google.com/group/django-users.

To contribute to Django:

* Check out http://www.djangoproject.com/community/ for information about
  getting involved.

To run Django's test suite:

* Follow the instructions in the "Unit tests" section of
  docs/internals/contributing/writing-code/unit-tests.txt, published online at
  https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/unit-tests/#running-the-unit-tests