From 2cadd8623915227d594be2b5a2749435215dd240 Mon Sep 17 00:00:00 2001 From: Adrian Holovaty Date: Sat, 28 Apr 2012 13:17:06 -0500 Subject: Renamed README to README.rst so that GitHub will give it the proper formatting --- README.rst | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 README.rst (limited to 'README.rst') diff --git a/README.rst b/README.rst new file mode 100644 index 0000000000..5ca89f1d78 --- /dev/null +++ b/README.rst @@ -0,0 +1,45 @@ +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 +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: + +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-users mailing list, or read the archives, at + http://groups.google.com/group/django-users. + +To contribute to Django: + + * Check out 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 -- cgit v1.3