README.rst 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. ======
  2. Django
  3. ======
  4. Django is a high-level Python web framework that encourages rapid development
  5. and clean, pragmatic design. Thanks for checking it out.
  6. All documentation is in the "``docs``" directory and online at
  7. https://docs.djangoproject.com/en/stable/. If you're just getting started,
  8. here's how we recommend you read the docs:
  9. * First, read ``docs/intro/install.txt`` for instructions on installing Django.
  10. * Next, work through the tutorials in order (``docs/intro/tutorial01.txt``,
  11. ``docs/intro/tutorial02.txt``, etc.).
  12. * If you want to set up an actual deployment server, read
  13. ``docs/howto/deployment/index.txt`` for instructions.
  14. * You'll probably want to read through the topical guides (in ``docs/topics``)
  15. next; from there you can jump to the HOWTOs (in ``docs/howto``) for specific
  16. problems, and check out the reference (``docs/ref``) for gory details.
  17. * See ``docs/README`` for instructions on building an HTML version of the docs.
  18. Docs are updated rigorously. If you find any problems in the docs, or think
  19. they should be clarified in any way, please take 30 seconds to fill out a
  20. ticket here: https://code.djangoproject.com/newticket
  21. To get more help:
  22. * Join the ``#django`` channel on ``irc.libera.chat``. Lots of helpful people
  23. hang out there. `Webchat is available <https://web.libera.chat/#django>`_.
  24. * Join the django-users mailing list, or read the archives, at
  25. https://groups.google.com/group/django-users.
  26. * Join the `Django Discord community <https://discord.gg/xcRH6mN4fa>`_.
  27. * Join the community on the `Django Forum <https://forum.djangoproject.com/>`_.
  28. To contribute to Django:
  29. * Check out https://docs.djangoproject.com/en/dev/internals/contributing/ for
  30. information about getting involved.
  31. To run Django's test suite:
  32. * Follow the instructions in the "Unit tests" section of
  33. ``docs/internals/contributing/writing-code/unit-tests.txt``, published online at
  34. https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/unit-tests/#running-the-unit-tests
  35. Supporting the Development of Django
  36. ====================================
  37. Django's development depends on your contributions.
  38. If you depend on Django, remember to support the Django Software Foundation: https://www.djangoproject.com/fundraising/