Go to file
François Freitag 9b15ff08ba Used auto-numbered lists in documentation. 2018-11-15 13:54:28 -05:00
.tx Removed contrib-messages entry in Transifex config file 2016-06-29 21:11:30 +02:00
django Fixed #17930 -- Allowed ORing (|) with sliced QuerySets. 2018-11-15 09:43:58 -05:00
docs Used auto-numbered lists in documentation. 2018-11-15 13:54:28 -05: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
tests Added a test for a lookup in Model.refresh_from_db(fields=[...]). 2018-11-15 11:38:47 -05:00
.editorconfig
.eslintignore
.eslintrc
.gitattributes
.gitignore
.hgignore
AUTHORS Fixed #29783 -- Added app label validation to showmigrations command. 2018-10-30 19:29:00 -04:00
CONTRIBUTING.rst
Gruntfile.js
INSTALL
LICENSE
LICENSE.python
MANIFEST.in
README.rst Removed dead links to botbot.me. 2018-11-10 17:25:10 -05:00
package.json
setup.cfg Ignored flake8 W504 warnings. 2018-10-24 09:17:59 -04:00
setup.py Fixed #29934 -- Added sqlparse as a require dependency. 2018-11-09 19:09:36 -05:00
tox.ini

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