Go to file
Alex Gaynor 2bcb8bfc8d Fix many many typos in comments throughout the codebase 2014-04-26 10:18:45 -07:00
.tx Renamed Transifex project from django-core to django 2014-04-24 11:38:18 +02:00
django Fix many many typos in comments throughout the codebase 2014-04-26 10:18:45 -07:00
docs Fixed #3214 -- Stopped parsing SQL with regex. 2014-04-26 17:46:23 +02:00
extras Skipped inclusion of scripts (pip will take care of that). 2013-12-29 14:01:55 +01:00
scripts Renamed Transifex project from django-core to django 2014-04-24 11:38:18 +02:00
tests Fix many many typos in comments throughout the codebase 2014-04-26 10:18:45 -07: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 Sycned .hginore with .gitignore. 2014-04-26 15:39:55 +02:00
AUTHORS Fixed #22328 -- Added --exclude option to compilemessages and makemessages. 2014-04-26 17:07:44 +07: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 #22464 - included contrib/gis/static in tarball 2014-04-18 08:00:41 +02:00
README.rst Converted links to HTTPS and linked to stable docs. 2013-12-29 22:35:37 +01:00
setup.cfg Appeased flake8 2.1.0. 2014-04-21 12:27:34 +02:00
setup.py Include an 'extra_requires' for bcrypt 2014-04-17 11:28:09 -07: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