Go to file
Tim Graham 3a829bf75a [1.5.x] Added some doc links for django.contrib.messages
Backport of b6178fa24b from master
2013-08-14 13:05:30 -04:00
.tx [1.5.x] Updated Transifex links to the Django project 2013-04-25 10:38:18 +02:00
django Bump version post-release. 2013-08-13 12:17:27 -05:00
docs [1.5.x] Added some doc links for django.contrib.messages 2013-08-14 13:05:30 -04:00
extras [1.5.x] Fixed #19252 -- Added support for wheel packages. 2013-05-01 13:52:38 +02:00
scripts [1.5.x] Updated Transifex links to the Django project 2013-04-25 10:38:18 +02:00
tests Apply autoescaping to AdminURLFieldWidget. 2013-08-13 11:04:21 -05:00
.gitattributes [1.5.x] Fixed #18920 -- Added `.gitattributes` to normalize line endings in HTML templates and avoid spurious failures in the core test suite on Windows. Many thanks to manfre, Claude Paroz, Karen Tracey, MaxV and Daniel Langer for their advising and testing. 2012-11-21 10:20:02 +01:00
.gitignore Fixed #16817 - Added a guide of code coverage to contributing docs. 2012-10-11 06:11:52 -04:00
.hgignore Fixed #16817 - Added a guide of code coverage to contributing docs. 2012-10-11 06:11:52 -04:00
AUTHORS [1.5.x] Fixed #17048 - Added docs for upgrading Django. 2013-05-22 08:57:57 -04:00
CONTRIBUTING.rst Fixed #18971 -- added root level CONTRIBUTING doc 2012-09-17 22:09:07 -07: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 [1.5.x] Fixed #19252 -- Added support for wheel packages. 2013-05-01 13:52:38 +02:00
README.rst Fix bullet formatting for README.rst. 2012-04-28 21:20:39 +01:00
setup.cfg [1.5.x] Removed comment from setup.cfg which broke newer wheel versions. 2013-07-28 10:57:34 +02:00
setup.py Bumped version numbers for 1.5.2. 2013-08-13 11:10:05 -05: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