| ====== |
| Django |
| ====== |
|
|
| 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.libera.chat``. Lots of helpful people |
| hang out there. `Webchat is available <https://web.libera.chat/#django>`_. |
| |
| * Join the django-users mailing list, or read the archives, at |
| https://groups.google.com/group/django-users. |
| |
| * Join the `Django Discord community <https://discord.gg/xcRH6mN4fa>`_. |
| |
| * Join the community on the `Django Forum <https://forum.djangoproject.com/>`_. |
| |
| 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/ |
|
|
| Supporting the Development of Django |
| ==================================== |
|
|
| Django's development depends on your contributions. |
| |
| If you depend on Django, remember to support the Django Software Foundation: https://www.djangoproject.com/fundraising/ |
| |
