summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJacob Kaplan-Moss <jacob@jacobian.org>2005-07-21 14:11:25 +0000
committerJacob Kaplan-Moss <jacob@jacobian.org>2005-07-21 14:11:25 +0000
commit4cb985df1638241c40c48b3637d6663652f12fcf (patch)
tree151c341898e1cdb4681c5363b6142b0c223c2551 /README
parentccffb199464e9b982f2972a29d5ecb35cf53f586 (diff)
Added a "suggested reading order" to the README (fixes #136 -- thanks paolo!). Also reworded some of the language in the README and added pointers to the various help resources.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@271 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'README')
-rw-r--r--README34
1 files changed, 29 insertions, 5 deletions
diff --git a/README b/README
index 78417c018d..ca3a10ce1a 100644
--- a/README
+++ b/README
@@ -1,12 +1,36 @@
Django is a high-level Python Web framework that encourages rapid development
and clean, pragmatic design.
-Thanks for downloading it.
+All documentation is in the "docs" directory and online at
+http://www.djangoproject.com/documentation/. If you're just getting started,
+here's a good order to read the docs:
-All documentation is in the "docs" directory. 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:
+ * First, read doc/install.txt for instructions on installing Django.
+
+ * Next, work through the tutorials in order (doc/tutorial01.txt,
+ doc/tutorial02.txt, etc.).
+
+ * If you want to set up an actual deployment server, read doc/modpython.txt
+ for instructions on running Django under mod_python.
+
+ * The rest of the documentation is of the reference-manual variety;
+ read it -- and the FAQ -- as you run into problems.
+
+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
-Install instructions are in the INSTALL file. \ No newline at end of file
+To get more help:
+
+ * Join the #django channel on irc.freenode.net; lots of helpful
+ people hang out there (read the archives at http://loglibrary.com/179).
+
+ * Join the django-users mailing list or read the archives at
+ http://groups-beta.google.com/group/django-users.
+
+To contribute to Django:
+
+ * Check out http://www.djangoproject.com/community/ for information
+ about getting involved.