Go to file
Marc Tamlyn f2dc4429a1 Reworked custom lookups docs.
Mostly just formatting and rewording, but also replaced the example
using ``YearExtract`` to  use an example which is unlikely to ever be
possible directly in the ORM.
2014-01-12 15:44:15 +00:00
.tx Updated Transifex links to the Django project 2013-04-25 10:35:51 +02:00
django Removed unused import 2014-01-12 13:19:13 +02:00
docs Reworked custom lookups docs. 2014-01-12 15:44:15 +00:00
extras Fixed E125 pep8 warnings 2013-11-28 08:50:11 -05:00
scripts Fixed `python scripts/manage_translations.py update_catalogs`. 2014-01-04 23:08:27 +01:00
tests Altered query string customization for backends vendors 2014-01-11 14:45:53 +02:00
.gitattributes Force Unix-style line-endings for some helper files in staticfiles_tests. 2013-09-30 22:14:54 -03:00
.gitignore Added __pycache__ to gitignore 2013-09-19 06:37:23 -04:00
.hgignore Added __pycache__ to gitignore 2013-09-19 06:37:23 -04:00
AUTHORS Fixed #21497 -- Forced conversion to bytes for very long index names 2013-11-24 13:15:50 -05:00
CONTRIBUTING.rst Fixed #21609 -- Amended CONTRIBUTING.rst pull request guidelines. 2013-12-26 13:41:03 -05:00
INSTALL Bumped minimum Python version requirement to 2.7 in Django 1.7. 2013-07-01 12:01:59 +02:00
LICENSE Whitespace cleanup. 2013-10-10 16:49:20 -04:00
MANIFEST.in Fixed #19252 -- Added support for wheel packages. 2013-05-01 13:46:06 +02:00
README.rst Converted links to HTTPS and linked to stable docs. 2013-12-29 22:35:37 +01:00
setup.cfg Added build to flake8.exclude. 2014-01-03 11:32:33 +01:00
setup.py Bumped minimum Python version requirement to 2.7 in Django 1.7. 2013-07-01 12:01:59 +02: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://www.djangoproject.com/community/ 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