Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

markdowned README

  • Loading branch information...
commit dabf5331c48362b16d843865857c726d68643e26 1 parent 4f8d751
@JCB-K JCB-K authored
Showing with 23 additions and 21 deletions.
  1. +23 −21 README.md
View
44 README.md
@@ -1,45 +1,47 @@
+# 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
-http://docs.djangoproject.com/en/dev/. If you're just getting started, here's
+[http://docs.djangoproject.com/en/dev/](http://docs.djangoproject.com/en/dev/). 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.
+* 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.
+* 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 ticket
-here:
+[here](http://code.djangoproject.com/newticket).
+
-http://code.djangoproject.com/newticket
### To get more help:
- * 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 channel on irc.freenode.net. Lots of helpful people
+ hang out there. Read the archives at [http://django-irc-logs.com/](http://django-irc-logs.com/).
- * Join the django-users mailing list, or read the archives, at
- http://groups.google.com/group/django-users.
+* Join the django-users mailing list, or read the archives, at
+ [http://groups.google.com/group/django-users](http://groups.google.com/group/django-users).
### To contribute to Django:
- * Check out http://www.djangoproject.com/community/ for information
- about getting involved.
+* Check out [http://www.djangoproject.com/community/](http://www.djangoproject.com/community/) 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
+* 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](https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/unit-tests/#running-the-unit-tests).
Please sign in to comment.
Something went wrong with that request. Please try again.