Go to file
Dmitry Shachnev f370bfb108 Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
.tx Removed contrib-messages entry in Transifex config file 2016-06-29 21:11:30 +02:00
django Fixed #27860 -- Dropped varchar_pattern_ops/text_pattern_ops index before altering char/text field in PostgreSQL. 2017-05-24 07:25:59 +02:00
docs Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
extras Fixed #25222 -- Avoided installing django_bash_completion for python*-config. 2015-08-04 14:27:31 -04:00
js_tests Refs #27795 -- Stopped converting integer format settings to str in JS/JSON i18n views 2017-05-08 19:32:03 +02:00
scripts Reverted "Fixed #27878, refs #23919 -- Used python3 shebangs." 2017-03-07 10:10:32 -05:00
tests Refs #27804 -- Used subTest() in several tests. 2017-05-24 08:36:34 -04:00
.editorconfig Added Python max_line_length to .editorconfig. 2016-06-13 10:41:56 -04:00
.eslintignore Refs #16501, #26474 -- Added xregexp.js source file. 2016-06-06 09:25:02 -04:00
.eslintrc Fixed #25165 -- Removed inline JavaScript from the admin. 2015-12-05 15:51:57 -05:00
.gitattributes Fixed #19670 -- Applied CachedFilesMixin patterns to specific extensions 2016-03-30 14:34:41 +02:00
.gitignore Fixed #22446 -- Added tox.ini to automate pull request checks. 2016-07-20 14:06:28 -04:00
.hgignore Synced .hgignore with .gitignore 2015-07-01 10:23:05 -04:00
AUTHORS Pointed Dive into Python links to python3 site 2017-05-20 15:32:35 +02:00
CONTRIBUTING.rst Added link to the code of conduct from contributing guides. 2015-04-17 18:12:41 -04:00
Gruntfile.js Fixed qunit tests (coverage still missing). (#7716) 2016-12-19 18:45:37 +01:00
INSTALL Refs #23919 -- Removed misc references to Python 2. 2017-01-21 20:02:00 -05:00
LICENSE Whitespace cleanup. 2013-10-10 16:49:20 -04:00
LICENSE.python Updated Python license for 2016. 2016-01-19 06:43:32 -05:00
MANIFEST.in Simplified MANIFEST.in 2015-12-12 12:07:21 -05:00
README.rst Added code highlighting in README.rst 2016-11-05 12:07:10 +01:00
package.json Fixed qunit tests (coverage still missing). (#7716) 2016-12-19 18:45:37 +01:00
setup.cfg Refs #23919 -- Removed misc Python 2/3 references. 2017-01-25 13:59:25 -05:00
setup.py Refs #23919 -- Removed misc Python 2/3 references. 2017-01-25 13:59:25 -05:00
tox.ini Refs #23919 -- Removed misc Python 2/3 references. 2017-01-25 13:59:25 -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
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 http://django-irc-logs.com/.

* 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