Go to file
Tim Graham b4fa94aed8 Removed code terms from docs/spelling_wordlist. 2018-07-31 12:22:28 -04:00
.tx
django Fixed #29617 -- Fixed Template crash if template_string is lazy. 2018-07-31 09:57:11 -04:00
docs Removed code terms from docs/spelling_wordlist. 2018-07-31 12:22:28 -04:00
extras Refs #23919 -- Removed Python 2 reference in django_bash_completion. 2017-07-10 08:54:52 -04:00
js_tests Added test for DateTimeShortcuts.js time zone warning. 2018-07-20 11:13:45 -04:00
scripts Refs #23968 -- Removed unnecessary lists, generators, and tuple calls. 2017-06-01 19:08:59 -04:00
tests Fixed #29617 -- Fixed Template crash if template_string is lazy. 2018-07-31 09:57:11 -04:00
.editorconfig Set max_line_length for docs in .editorconfig. 2018-06-20 09:24:58 -04:00
.eslintignore
.eslintrc
.gitattributes
.gitignore
.hgignore
AUTHORS Fixed #28291, #24726 -- Fixed ArrayField with JSONField and RangeFields. 2018-07-27 11:35:54 -04:00
CONTRIBUTING.rst
Gruntfile.js
INSTALL Fixed #27857 -- Dropped support for Python 3.4. 2017-09-25 17:11:03 -04:00
LICENSE
LICENSE.python Fixed #29261 -- Doc'd the reason for LICENSE.python. 2018-06-29 20:00:58 -04:00
MANIFEST.in
README.rst Added a link in README.rst for people new to IRC. 2017-10-24 13:59:17 -04:00
package.json
setup.cfg
setup.py Refs #28814 -- Documented Python 3.7 compatibility. 2018-06-28 11:02:29 -04:00
tox.ini Refs #28814 -- Documented Python 3.7 compatibility. 2018-06-28 11:02:29 -04: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
https://docs.djangoproject.com/en/stable/. 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: https://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 https://botbot.me/freenode/django/. See
  https://en.wikipedia.org/wiki/Wikipedia:IRC/Tutorial if you're new to IRC.

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

To contribute to Django:

* Check out https://docs.djangoproject.com/en/dev/internals/contributing/ 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