Go to file
Johannes Hoppe f13bd32110 Refs #14370 -- Fixed typo in ModelAdmin.autocomplete_fields docs. 2017-09-19 08:51:46 -04:00
.tx
django Refs #28334 -- Fixed crash in hstore/citext oid caching during test db creation. 2017-09-19 07:04:31 -04:00
docs Refs #14370 -- Fixed typo in ModelAdmin.autocomplete_fields docs. 2017-09-19 08:51:46 -04:00
extras Refs #23919 -- Removed Python 2 reference in django_bash_completion. 2017-07-10 08:54:52 -04:00
js_tests Fixed #28295 -- Made admin's URLify.js trim trailing hyphens. 2017-06-13 14:58:30 -04:00
scripts Refs #23968 -- Removed unnecessary lists, generators, and tuple calls. 2017-06-01 19:08:59 -04:00
tests Refs #28334 -- Fixed crash in hstore/citext oid caching during test db creation. 2017-09-19 07:04:31 -04:00
.editorconfig
.eslintignore
.eslintrc
.gitattributes
.gitignore
.hgignore
AUTHORS Fixed #26818 -- Added responsive CSS for the admin. 2017-09-16 19:11:19 -04:00
CONTRIBUTING.rst
Gruntfile.js
INSTALL Refs #23919 -- Removed misc references to Python 2. 2017-01-21 20:02:00 -05:00
LICENSE
LICENSE.python
MANIFEST.in
README.rst Refs #17453 -- Fixed broken link to #django IRC logs. 2017-07-21 18:09:48 -04:00
package.json
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 https://botbot.me/freenode/django/.

* 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