Gokmen Gorgen avatar Gokmen Gorgen committed 41f0fb1

Rename README as README.rst and move INSTALL file content to this file.

Comments (0)

Files changed (3)

INSTALL

-============
-Installation
-============
-
- * Use pip or easy_install to install "feedzilla" package
- * Install dependencies (see below)
- * Add feedzilla to INSTALLED_APPS
- * Run `manage.py syncdb` or `manage.py sync` if you use South.
- * Include `url('', include('feedzilla.urls'))` in url config
- * Setup Site instance via Django admin interface
- * Setup feedzilla settings via settings.py.  See available settings below.
-    You have to import default settings with "from feedzilla.settings import *" line.
- * Setup static files. You should copy or symlink `static/feedzilla` directory contents from feedzilla installation directory to your %MEDIA_ROOT%.
- * Play with templates. Probably you'll want override some of default templates.
-
-
-Dependencies
-============
-
- * django-common
- * django-tagging
- * feedparser
-
-
-Settings 
-========
-
- * FEEDZILLA_PAGE_SIZE - number of items per page
- * FEEDZILLA_SUMMARY_SIZE
- * FEEDZILLA_SITE_TITLE - used in feed generation
- * FEEDZILLA_SITE_DESCRIPTION - used in feed generation
-
-For actual list of settings look into feedzilla/settings.py

README

-============================
-Feedzilla Django Application
-============================
-
-This is django application that adds to your site ability to aggregate
-ATOM/RSS feeds and display them in single stream. In other words you can
-use feedzilla to build planet site.
-
-Project page: http://bitbucket.org/lorien/feedzilla
-
-
-Installation
-============
-For installation instructions and list of settings look into INSTALL document.
+============================
+Feedzilla Django Application
+============================
+
+This is Django application that adds to your site ability to aggregate
+ATOM/RSS feeds and display them in single stream. In other words you can
+use feedzilla to build planet site.
+
+Project page: http://bitbucket.org/lorien/feedzilla
+
+Installation
+============
+
+* Use ``pip`` or ``easy_install`` to install *feedzilla* package.
+* Install dependencies (see below).
+* Add feedzilla to INSTALLED_APPS.
+* Run ``manage.py syncdb`` or ``manage.py sync`` if you use South.
+* Include ``url('', include('feedzilla.urls'))`` in url config.
+* Setup Site instance via Django admin interface.
+* Setup feedzilla settings via settings.py. See available settings below.
+  You have to import default settings with ``from feedzilla.settings import *``
+  line.
+* Setup static files. You should copy or symlink ``static/feedzilla`` directory
+  contents from feedzilla installation directory to your ``%MEDIA_ROOT%``.
+* Play with templates. Probably you'll want override some of default templates.
+
+Dependencies
+============
+
+* django-common
+* django-tagging
+* feedparser
+
+Settings
+========
+
+* ``FEEDZILLA_PAGE_SIZE`` - number of items per page
+* ``FEEDZILLA_SUMMARY_SIZE``
+* ``FEEDZILLA_SITE_TITLE`` - used in feed generation
+* ``FEEDZILLA_SITE_DESCRIPTION`` - used in feed generation
+
+For actual list of settings look into ``feedzilla/settings.py``
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.