Commit: 15b090a5bf7d4c037e9eb7b5de62fdc9fa91fa32 - newsfour (git)

news4 - RSS aggrigation system

Commit MetaInfo

• Revision: 15b090a5bf7d4c037e9eb7b5de62fdc9fa91fa32 (tree)
• Time: 2012-10-18 22:38:27
• Author: hylom <hylom@hylo...>
• Commiter: hylom

Log Message

README: write more

Change Summary

• modified: README

Incremental Difference

--- a/README
+++ b/README
@@ -1,10 +1,32 @@
-README
-
-requires:
-	mako (Makotenplate library for Python)
-
-	feedparser (feed library for Python)
-	http://code.google.com/p/feedparser
-
-        python-dateutil
-        
\ No newline at end of file
+= 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の生成先やサイト名、RSSの取得先などを設定するファイルです。PythonのDictionaryおよびArray形式で記述されています。
+　config.py.sampleをコピーしてconfig.pyを作成し、編集します。
+
+=== install.conf ===
+　関連ファイルのコピー先を指定するファイルです。
+　install.conf.sampleをコピーしてintall.confを作成し、編集します。
+
+=== keywords.txt ===
+　記事の分類を行うためのキーワードを指定するファイルです。
+　keywords.txt.sampleをコピーしてkeywords.txtを作成し、編集します。
+
+== 関連ファイルのインストール ==
+　上記の設定ファイルを用意したうえで、make installを実行します。
+
+== サイトの作成・更新
+　makeを実行します。