Go to file
Joachim Jablon 8ba20d9071 Refs #30512 -- Added tests for sanitizing email addresses with display name and two @ signs. 2019-06-06 15:05:56 +02:00
.tx Removed contrib-messages entry in Transifex config file 2016-06-29 21:11:30 +02:00
django Fixed #29706 -- Made RenameContentType._rename() save to the correct database. 2019-06-06 12:09:01 +02:00
docs Refs #30226 -- Added User.get_user_permissions() method. 2019-06-05 13:56:37 +02:00
extras Fixed #30283 -- Fixed shellcheck warnings in django_bash_completion. 2019-03-23 11:56:44 -04:00
js_tests Removed unused timeparse.js. 2019-03-27 09:24:09 -04:00
scripts Capitalized "Python" in docs and comments. 2018-10-09 09:26:07 -04:00
tests Refs #30512 -- Added tests for sanitizing email addresses with display name and two @ signs. 2019-06-06 15:05:56 +02:00
.editorconfig Refs #29784 -- Switched to https:// links where available. 2018-09-26 08:48:47 +02:00
.eslintignore
.eslintrc
.gitattributes
.gitignore
.hgignore
AUTHORS Fixed #30505 -- Doc'd how changes in the order of Field.choices affect migrations. 2019-06-04 14:11:41 +02:00
CONTRIBUTING.rst
Gruntfile.js
INSTALL Fixed #30116 -- Dropped support for Python 3.5. 2019-01-30 10:19:48 -05: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 Removed dead links to botbot.me. 2018-11-10 17:25:10 -05:00
package.json
setup.cfg Removed deprecated license-file from setup.cfg. 2019-05-08 10:20:35 +02:00
setup.py Fixed #30116 -- Dropped support for Python 3.5. 2019-01-30 10:19:48 -05:00
tox.ini Fixed #30367 -- Changed "pip install" to "python -m pip install" in docs, comments and hints. 2019-04-18 14:41:15 +02: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. 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