1. ======

  2. Django

  3. ======

  4. 

  5. Django is a high-level Python web framework that encourages rapid development

  6. and clean, pragmatic design. Thanks for checking it out.

  7. 

  8. All documentation is in the "``docs``" directory and online at

  9. https://docs.djangoproject.com/en/stable/. If you're just getting started,

  10. here's how we recommend you read the docs:

  11. 

  12. * First, read ``docs/intro/install.txt`` for instructions on installing Django.

  13. 

  14. * Next, work through the tutorials in order (``docs/intro/tutorial01.txt``,

  15.   ``docs/intro/tutorial02.txt``, etc.).

  16. 

  17. * If you want to set up an actual deployment server, read

  18.   ``docs/howto/deployment/index.txt`` for instructions.

  19. 

  20. * You'll probably want to read through the topical guides (in ``docs/topics``)

  21.   next; from there you can jump to the HOWTOs (in ``docs/howto``) for specific

  22.   problems, and check out the reference (``docs/ref``) for gory details.

  23. 

  24. * See ``docs/README`` for instructions on building an HTML version of the docs.

  25. 

  26. Docs are updated rigorously. If you find any problems in the docs, or think

  27. they should be clarified in any way, please take 30 seconds to fill out a

  28. ticket here: https://code.djangoproject.com/newticket

  29. 

  30. To get more help:

  31. 

  32. * Join the ``#django`` channel on ``irc.libera.chat``. Lots of helpful people

  33.   hang out there. See https://web.libera.chat if you're new to IRC.

  34. 

  35. * Join the django-users mailing list, or read the archives, at

  36.   https://groups.google.com/group/django-users.

  37. 

  38. To contribute to Django:

  39. 

  40. * Check out https://docs.djangoproject.com/en/dev/internals/contributing/ for

  41.   information about getting involved.

  42. 

  43. To run Django's test suite:

  44. 

  45. * Follow the instructions in the "Unit tests" section of

  46.   ``docs/internals/contributing/writing-code/unit-tests.txt``, published online at

  47.   https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/unit-tests/#running-the-unit-tests

  48. 

  49. Supporting the Development of Django

  50. ====================================

  51. 

  52. Django's development depends on your contributions. 

  53. 

  54. If you depend on Django, remember to support the Django Software Foundation: https://www.djangoproject.com/fundraising/
About Sign Up Leave Feedback Contact