1
0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
Go to file
2018-07-09 14:59:42 -04:00
.tx
django Refs #29548 -- Fixed non-GIS test failures on MariaDB. 2018-07-09 14:59:42 -04:00
docs Refs #29478 -- Doc'd how to use cached_property with a mangled name. 2018-07-09 12:13:31 -04:00
extras Refs #23919 -- Removed Python 2 reference in django_bash_completion. 2017-07-10 08:54:52 -04:00
js_tests Fixed #29536 -- Fixed SelectFilter2.js resizing to make boxes have equal height. 2018-06-29 17:21:27 +02:00
scripts Refs #23968 -- Removed unnecessary lists, generators, and tuple calls. 2017-06-01 19:08:59 -04:00
tests Refs #29548 -- Fixed non-GIS test failures on MariaDB. 2018-07-09 14:59:42 -04:00
.editorconfig Set max_line_length for docs in .editorconfig. 2018-06-20 09:24:58 -04:00
.eslintignore
.eslintrc
.gitattributes
.gitignore Fixed #22446 -- Added tox.ini to automate pull request checks. 2016-07-20 14:06:28 -04:00
.hgignore
AUTHORS Fixed #20584 -- Fixed memcached's get_many() with single-use iterators. 2018-07-09 10:24:41 -04:00
CONTRIBUTING.rst
Gruntfile.js Fixed qunit tests (coverage still missing). (#7716) 2016-12-19 18:45:37 +01:00
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
package.json Fixed qunit tests (coverage still missing). (#7716) 2016-12-19 18:45:37 +01:00
README.rst Added a link in README.rst for people new to IRC. 2017-10-24 13:59:17 -04:00
setup.cfg Refs #23919 -- Removed misc Python 2/3 references. 2017-01-25 13:59:25 -05:00
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

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