Changed back from .rst to .txt to match Django's convention
authorfloguy <floguy@7f1efe38-554e-0410-b69d-834cb44da2d5>
Fri, 19 Sep 2008 03:54:02 +0000 (03:54 +0000)
committerfloguy <floguy@7f1efe38-554e-0410-b69d-834cb44da2d5>
Fri, 19 Sep 2008 03:54:02 +0000 (03:54 +0000)
git-svn-id: https://django-pagination.googlecode.com/svn/trunk@34 7f1efe38-554e-0410-b69d-834cb44da2d5

INSTALL.rst [deleted file]
INSTALL.txt [new file with mode: 0644]
README.rst [deleted file]
README.txt [new file with mode: 0644]

diff --git a/INSTALL.rst b/INSTALL.rst
deleted file mode 100644 (file)
index b370b5d..0000000
+++ /dev/null
@@ -1,19 +0,0 @@
-Installing django-pagination
-----------------------------
-
-To install, first check out the latest version of the application from
-subversion:
-
-    svn co http://django-pagination.googlecode.com/svn/trunk django-pagination
-
-Now, link the inner ``pagination`` project to your Python path:
-
-    sudo ln -s `pwd`/pagination SITE_PACKAGES_DIR/pagination
-
-If you don't know the location of your site packages directory, this hack might
-do the trick for you:
-
-    sudo ln -s `pwd`/pagination `python -c "from distutils.sysconfig import get_python_lib; print get_python_lib()"`/pagination
-    
-Now it's installed.  Please see README.txt for information on how to use this
-application in your projects.
\ No newline at end of file
diff --git a/INSTALL.txt b/INSTALL.txt
new file mode 100644 (file)
index 0000000..b370b5d
--- /dev/null
@@ -0,0 +1,19 @@
+Installing django-pagination
+----------------------------
+
+To install, first check out the latest version of the application from
+subversion:
+
+    svn co http://django-pagination.googlecode.com/svn/trunk django-pagination
+
+Now, link the inner ``pagination`` project to your Python path:
+
+    sudo ln -s `pwd`/pagination SITE_PACKAGES_DIR/pagination
+
+If you don't know the location of your site packages directory, this hack might
+do the trick for you:
+
+    sudo ln -s `pwd`/pagination `python -c "from distutils.sysconfig import get_python_lib; print get_python_lib()"`/pagination
+    
+Now it's installed.  Please see README.txt for information on how to use this
+application in your projects.
\ No newline at end of file
diff --git a/README.rst b/README.rst
deleted file mode 100644 (file)
index 1a86b09..0000000
+++ /dev/null
@@ -1,70 +0,0 @@
-How to use django-pagination
-----------------------------
-
-``django-pagination`` allows for easy Digg-style pagination without modifying
-your views.
-
-There are really 5 steps to setting it up with your projects (not including 
-installation, which is covered in INSTALL.txt in this same directory.)
-
-1. List this application in the ``INSTALLED_APPS`` portion of your settings
-   file.  Your settings file might look something like::
-   
-       INSTALLED_APPS = (
-           # ...
-           'pagination',
-       )
-
-
-2. Install the pagination middleware.  Your settings file might look something
-   like::
-   
-       MIDDLEWARE_CLASSES = (
-           # ...
-           'pagination.middleware.PaginationMiddleware',
-       )
-
-3. If it's not already added in your setup, add the request context processor.
-   Note that context processors are set by default implicitly, so to set them
-   explicitly, you need to copy and paste this code into your under
-   the value TEMPLATE_CONTEXT_PROCESSORS::
-   
-        ("django.core.context_processors.auth",
-        "django.core.context_processors.debug",
-        "django.core.context_processors.i18n",
-        "django.core.context_processors.media",
-        "django.core.context_processors.request")
-
-4. Add this line at the top of your template to load the pagination tags:
-
-       {% load pagination_tags %}
-
-
-5. Decide on a variable that you would like to paginate, and use the
-   autopaginate tag on that variable before iterating over it.  This could 
-   take one of two forms (using the canonical ``object_list`` as an example
-   variable):
-   
-       {% autopaginate object_list %}
-       
-   This assumes that you would like to have the default 20 results per page.
-   If you would like to specify your own amount of results per page, you can
-   specify that like so:
-   
-       {% autopaginate object_list 10 %}
-   
-   Note that this replaces ``object_list`` with the list for the current page, so
-   you can iterate over the ``object_list`` like you normally would.
-   
-
-6. Now you want to display the current page and the available pages, so
-   somewhere after having used autopaginate, use the paginate inclusion tag:
-   
-       {% paginate %}
-   
-   This does not take any arguments, but does assume that you have already
-   called autopaginate, so make sure to do so first.
-
-
-That's it!  You have now paginated ``object_list`` and given users of the site
-a way to navigate between the different pages--all without touching your views.
diff --git a/README.txt b/README.txt
new file mode 100644 (file)
index 0000000..1a86b09
--- /dev/null
@@ -0,0 +1,70 @@
+How to use django-pagination
+----------------------------
+
+``django-pagination`` allows for easy Digg-style pagination without modifying
+your views.
+
+There are really 5 steps to setting it up with your projects (not including 
+installation, which is covered in INSTALL.txt in this same directory.)
+
+1. List this application in the ``INSTALLED_APPS`` portion of your settings
+   file.  Your settings file might look something like::
+   
+       INSTALLED_APPS = (
+           # ...
+           'pagination',
+       )
+
+
+2. Install the pagination middleware.  Your settings file might look something
+   like::
+   
+       MIDDLEWARE_CLASSES = (
+           # ...
+           'pagination.middleware.PaginationMiddleware',
+       )
+
+3. If it's not already added in your setup, add the request context processor.
+   Note that context processors are set by default implicitly, so to set them
+   explicitly, you need to copy and paste this code into your under
+   the value TEMPLATE_CONTEXT_PROCESSORS::
+   
+        ("django.core.context_processors.auth",
+        "django.core.context_processors.debug",
+        "django.core.context_processors.i18n",
+        "django.core.context_processors.media",
+        "django.core.context_processors.request")
+
+4. Add this line at the top of your template to load the pagination tags:
+
+       {% load pagination_tags %}
+
+
+5. Decide on a variable that you would like to paginate, and use the
+   autopaginate tag on that variable before iterating over it.  This could 
+   take one of two forms (using the canonical ``object_list`` as an example
+   variable):
+   
+       {% autopaginate object_list %}
+       
+   This assumes that you would like to have the default 20 results per page.
+   If you would like to specify your own amount of results per page, you can
+   specify that like so:
+   
+       {% autopaginate object_list 10 %}
+   
+   Note that this replaces ``object_list`` with the list for the current page, so
+   you can iterate over the ``object_list`` like you normally would.
+   
+
+6. Now you want to display the current page and the available pages, so
+   somewhere after having used autopaginate, use the paginate inclusion tag:
+   
+       {% paginate %}
+   
+   This does not take any arguments, but does assume that you have already
+   called autopaginate, so make sure to do so first.
+
+
+That's it!  You have now paginated ``object_list`` and given users of the site
+a way to navigate between the different pages--all without touching your views.