1
0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
Go to file
Chaitanya Rahalkar 58404eedb2
Update docs/faq/help.txt
Co-authored-by: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com>
2024-11-15 08:39:30 +05:30
.github Made GitHub actions display all warnings in Python tests. 2024-10-25 10:05:19 +02:00
.tx Updated Transifex configuration for new CLI. 2023-04-02 09:54:33 +02:00
django Refs #21286 -- Fixed YAML serialization of TimeField primary key. 2024-11-12 13:23:14 +01:00
docs Update docs/faq/help.txt 2024-11-15 08:39:30 +05:30
extras Migrated setuptools configuration to pyproject.toml. 2024-06-24 15:34:43 -03:00
js_tests Refs #35189 -- Removed no longer necessary JavaScript file collapse.js. 2024-05-22 00:13:55 -03:00
scripts Extended script to manage translations to support fetching new translations since a given date. 2024-08-05 13:51:28 -03:00
tests Refs #21286 -- Fixed YAML serialization of TimeField primary key. 2024-11-12 13:23:14 +01:00
.editorconfig Refs #33476 -- Adjusted docs and config files for Black. 2022-02-07 20:36:04 +01:00
.flake8 Migrated setuptools configuration to pyproject.toml. 2024-06-24 15:34:43 -03:00
.git-blame-ignore-revs Ignored 305757aec1 formatting changes in git blame. 2024-01-26 12:46:08 +01:00
.gitattributes
.gitignore Refs #34043 -- Added --screenshots option to runtests.py and selenium tests. 2023-10-18 06:14:40 +02:00
.pre-commit-config.yaml Bumped versions in pre-commit and npm configurations. 2024-10-08 17:58:53 -03:00
.readthedocs.yml Configured Read The Docs to build all formats. 2021-11-18 12:21:00 +01:00
AUTHORS Fixed #35849 -- Made ParallelTestSuite report correct error location. 2024-11-06 17:14:41 +01:00
CONTRIBUTING.rst
eslint.config.mjs Migrated to ESLint 9+. 2024-05-06 11:42:37 +02:00
Gruntfile.js
INSTALL Fixed #34233 -- Dropped support for Python 3.8 and 3.9. 2023-01-18 09:46:01 +01:00
LICENSE
LICENSE.python Updated Python license for 2024. 2024-01-27 11:54:02 +01:00
MANIFEST.in Migrated setuptools configuration to pyproject.toml. 2024-06-24 15:34:43 -03:00
package.json Bumped versions in pre-commit and npm configurations. 2024-10-08 17:58:53 -03:00
pyproject.toml Refs #34900 -- Doc'd Python 3.13 compatibility. 2024-10-09 09:27:33 +02:00
README.rst Fixed #34678 -- Added Django Forum and Discord server to README.rst. 2023-06-26 05:28:28 +02:00
tox.ini Refs #34900 -- Doc'd Python 3.13 compatibility. 2024-10-09 09:27:33 +02:00

======
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/#running-the-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/