1
0
mirror of https://github.com/django/django.git synced 2024-11-18 07:26:04 +00:00
Go to file
2018-01-20 12:38:48 -05:00
.tx Removed contrib-messages entry in Transifex config file 2016-06-29 21:11:30 +02:00
django Removed library name from file names of admin's JavaScript library licenses. 2018-01-20 12:30:00 -05:00
docs Fixed #28343 -- Add an OS chooser for docs command line examples. 2018-01-20 12:38:48 -05:00
extras Refs #23919 -- Removed Python 2 reference in django_bash_completion. 2017-07-10 08:54:52 -04:00
js_tests Refs #28956 -- Removed usage of jQuery's deprecated .selector property in admin JavaScript. 2017-12-26 10:21:05 -05:00
scripts Refs #23968 -- Removed unnecessary lists, generators, and tuple calls. 2017-06-01 19:08:59 -04:00
tests Fixed #29041 -- Changed SelectMultiple's multiple attribute to HTML5 boolean syntax. 2018-01-20 11:19:06 -05: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
.gitattributes
.gitignore Fixed #22446 -- Added tox.ini to automate pull request checks. 2016-07-20 14:06:28 -04:00
.hgignore
AUTHORS Fixed #28761 -- Documented how an inline formset's prefix works. 2018-01-13 16:20:34 -05: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 Updated Python license for 2018. 2018-01-05 08:13:55 -05: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 Fixed #28878 -- Added python_requires in setup.py and a warning for older pips that don't recognize it. 2017-12-22 18:25:05 -05:00
tox.ini Refs #27857 -- Removed Python 3.4 from tox.ini. 2017-10-06 09:09:05 -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