- Notifications
You must be signed in to change notification settings - Fork31.5k
README.rst
58 lines (38 loc) · 2.23 KB
README.rst
Django is a high-level Python web framework that encourages rapid developmentand clean, pragmatic design. Thanks for checking it out.
All documentation is in the "docs
" directory and online athttps://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 (indocs/howto
) for specificproblems, 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 thinkthey should be clarified in any way, please take 30 seconds to fill out aticket here:https://code.djangoproject.com/newticket
To get more help:
- Join the
#django
channel onirc.libera.chat
. Lots of helpful peoplehang out there.Webchat is available. - Join the django-users mailing list, or read the archives, athttps://groups.google.com/group/django-users.
- Join theDjango Discord community.
- Join the community on theDjango Forum.
To contribute to Django:
- Check outhttps://docs.djangoproject.com/en/dev/internals/contributing/ forinformation 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 athttps://docs.djangoproject.com/en/dev/internals/contributing/writing-code/unit-tests/#running-the-unit-tests
Django's development depends on your contributions.
If you depend on Django, remember to support the Django Software Foundation:https://www.djangoproject.com/fundraising/