Added code highlighting in README.rst
This commit is contained in:
parent
b741fe397a
commit
5b5bfbda98
22
README.rst
22
README.rst
|
@ -1,23 +1,23 @@
|
|||
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
|
||||
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.
|
||||
* 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.).
|
||||
* 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.
|
||||
``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.
|
||||
* 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.
|
||||
* 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
|
||||
|
@ -25,7 +25,7 @@ ticket here: https://code.djangoproject.com/newticket
|
|||
|
||||
To get more help:
|
||||
|
||||
* Join the #django channel on irc.freenode.net. Lots of helpful people hang out
|
||||
* Join the ``#django`` channel on irc.freenode.net. Lots of helpful people hang out
|
||||
there. Read the archives at http://django-irc-logs.com/.
|
||||
|
||||
* Join the django-users mailing list, or read the archives, at
|
||||
|
@ -39,5 +39,5 @@ To contribute to Django:
|
|||
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
|
||||
``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
|
||||
|
|
Loading…
Reference in New Issue