= README =

== gnewsとは？ ==
　ニュース記事を収集・分類するニュースアグリゲーションサイトを構築するためのツールです。静的にHTMLを作成するのが特徴です。Planetにインスパイアされ、Google Newsクローンを目指しています。

== 必要なライブラリ ==
　利用には下記のPythonモジュールおよびGNU makeが必要です。

 * mako (python-mako、Makotenplate library for Python)
 * feedparser (python-feedparser、feed library for Python) http://code.google.com/p/feedparser
 * python-dateutil

== 設定ファイルの作成 ==
　gnewsでサイトを生成するために、下記の設定ファイルが必要です。

=== config.py ===
　HTMLの生成先やサイト名などを設定するファイルです。PythonのDictionaryおよびArray形式で記述されています。
　config.py.sampleをコピーしてconfig.pyを作成し、編集します。

=== sources.ini ===
　RSSの取得先を設定するファイルです。ini形式で記述されています。セクション名が表示されるサイト名、urlパラメータがサイトのURL、sourcesパラメータがRSSの取得先、filtersが使用するフィルタ一覧（カンマ区切り）となります。

=== install.conf ===
　関連ファイルのコピー先を指定するファイルです。
　install.conf.sampleをコピーしてintall.confを作成し、編集します。

=== keywords.txt ===
　記事の分類を行うためのキーワードを指定するファイルです。
　keywords.txt.sampleをコピーしてkeywords.txtを作成し、編集します。

== 関連ファイルのインストール ==
　上記の設定ファイルを用意したうえで、make installを実行します。

== サイトの作成・更新
　makeを実行します。