#+TITLE: ryuslash.org
#+STYLE: <link rel="stylesheet" type="text/css" href="../../stylesheet.css" />
#+LINK_UP: ../index.html
#+LINK_HOME: ../index.html
#+LINK: python     http://www.python.org
#+LINK: django     http://djangoproject.com
#+LINK: feedparser http://code.google.com/p/feedparser/
#+LINK: south      http://south.aeracode.org/
#+LINK: markdown   http://packages.python.org/Markdown/
#+LINK: src        https://github.com/ryuslash/ryuslash.org
#+LINK: tar_gz     https://github.com/ryuslash/ryuslash.org/tarball/master
#+LINK: zip        https://github.com/ryuslash/ryuslash.org/zipball/master

#+INCLUDE: "../header.org" :lines "1-4"
#+INCLUDE: "dlmenu.inc"

* About
  :PROPERTIES:
  :hosted_at: github
  :END:

  ~ryuslash.org~ is the project of the front page of [[http://ryuslash.org][my website]]. I
  have noticed, though, that apart from the /design/ and the initial
  data[fn:: The configured feeds], there is nothing really specific to
  my about this project.

  Right now all it really does is show a bunch of feeds on a page.

** Why

   I've been trying out different kinds of ways to manage/run a
   website/blog for a long time now, and I can't seem to keep using
   just one thing. This annoys me.

   With ~ryuslash.org~ I'm trying it in a different way, gather
   everything I do elsewhere and present it in a single place. I
   *must* be generating content /somewhere/, and if that's true, and
   friends or other interested people might want to know about this,
   then it's nice to have it all in one place.

** How

   ~ryuslash.org~ uses the [[python][Python]] web framework [[django][django]] and the [[python][Python]]
   module [[feedparser][feedparser]]. It uses a management command ~loadfeeds~ to go
   through all the configured feeds and check them for new items.

** Features

   - Define multiple RSS feeds to load news items from.
   - Define relative paths for the xml and profile linked to a feed.
   - Group feeds in categories.
   - Add comments to any post that comes in.
   - Generate feeds: One for all posts, one for all comments.

** Requirements

   ~ryuslash.org~ uses the following modules and applications:

   - [[python][Python]] 2.6.x or 2.7.x
   - [[django][Django]] 1.3
   - [[south][South]] 0.7.4
   - [[feedparser][Feedparser]] 5.1.1
   - [[markdown][Markdown]] 2.1.1

* Installation

  Must write...

* Configuration

  The feeds that are loaded are defined in the database, through the
  ~Feed~ model. Now when you want to run your own instance, it might
  be preferable *not* to load my feeds, so you should remove (part of)
  or change ~aggregator/fixtures/initial_data.json~, otherwise your
  feeds will be overwritten by my feeds every time you migrate.