Commits

Anonymous committed f53849a

update documentation

Comments (0)

Files changed (3)

 People who have worked on django-fitlog
 ---------------------------------------
-Ken Cochrane - initial code
+Ken Cochrane - initial code
+John Costa
 Requirements
 ------------
-* Django 1.1 or newer
+* Django 1.5 or newer
 * Django sessions need to be enabled
 * Django south 0.7 or newer for migrations
 * django pagination
 
+------------
+Installation
+------------
+
+`pip install hg+https://bitbucket.org/kencochrane`
+
 --------
 Settings
 --------
 
 App
 ===
-Add fitlog to INSTALLED_APPS
+Add the following to your INSTALLED_APPS:
+
+```
+INSTALLED_APPS = [
+    ...
+    'fitlog',
+    'south',
+    'pagination',
+]
+```
+
+Add the following TEMPLATE_CONTEXT_PROCESSORS:
+
+```
+TEMPLATE_CONTEXT_PROCESSORS = (
+    "django.contrib.auth.context_processors.auth",
+    "django.core.context_processors.debug",
+    "django.core.context_processors.i18n",
+    "django.core.context_processors.media",
+    "django.core.context_processors.request")
+```
+
+Add the following middleware:
+
+```
+MIDDLEWARE_CLASSES = (
+    ...
+    'pagination.middleware.PaginationMiddleware',
+)
+```
 
 Sync Tables
 ===========
 Requirements
 ------------
 
-Django 1.1 or newer
-
+Django 1.5 or newer
 Django South 0.7 or newer
-
 Django Pagination
 
 Code Repo
     INSTALLED_APPS = (
         ...
         'fitlog',
+        'south',
+        'pagination',
     )
 
+Add the following TEMPLATE_CONTEXT_PROCESSORS::
+
+    TEMPLATE_CONTEXT_PROCESSORS = (
+        ...
+        "django.contrib.auth.context_processors.auth",
+        "django.core.context_processors.debug",
+        "django.core.context_processors.i18n",
+        "django.core.context_processors.media",
+        "django.core.context_processors.request"
+    )
+
+Add the following middleware::
+
+    MIDDLEWARE_CLASSES = (
+        ...
+        'pagination.middleware.PaginationMiddleware',
+    )
 
 Now load up the tables in your database::