Small doc and cosmetic changes.

GTLL · Jan 15, 2011 · 7d8dce4 · 7d8dce4
1 parent 56c4d11
commit 7d8dce4
Show file tree

Hide file tree

Showing 8 changed files with 63 additions and 44 deletions.
diff --git a/INSTALL.md b/INSTALL.md
@@ -0,0 +1,36 @@
+How to install?
+===============
+
+## Install virtualenv and pip
+
+Mac:
+
+    $ port install py26-virtualenv py26-pip
+
+Linux:
+
+    $ apt-get install python-virtualenv python-pip
+
+Etc.
+
+## Install the app
+
+Type:
+
+$ make
+
+## Run
+
+a) Start the server with:
+
+    $ make serve
+
+b) Crawl the feed with:
+
+    $ ./ring.sh crawl
+
+(You might want to set up a crontab).
+
+## Configure
+
+Edit `ring.cfg`
diff --git a/INSTALL.txt b/INSTALL.txt
diff --git a/NOTES.txt → NOTES.md b/NOTES.txt → NOTES.md
@@ -1,4 +1,4 @@
-Goals for the Planetoid project
+Goals for the Ring project
 ===============================
 
 Features

diff --git a/README.txt → README.md b/README.txt → README.md
diff --git a/ROADMAP.txt b/ROADMAP.txt
@@ -1,5 +1,10 @@
+DONE
+====
+
+No release yet.
+
 TODO
-----
+====
 
 V. 0.1
 ------
@@ -8,34 +13,33 @@ Focus: get the basic functionalities out.
 
 + Web server w/ templates
 + Textfile-based configuration
++ Web scrapping
 
+- Tests
 - File logging
 - Simple regex-based filters
-- Web scrapping
+- Genericise
+- Make a proper release on PyPi
 
 V. 0.2
 ------
 
 Focus: fix issues w/ 0.1 + enhancements
 
-- Tests
+- Language detection + dynamic language presenting
 - Automatic deployment (Fabric)
 - Static generator
 - Logging
 - Support for several DBs
 - Pluggable filters
 - Improve basic theme
+- Archive
 
 V. 0.3
 ------
 
 - Search
 
-V. 0.4
-------
-
-- Extract common functionalities as the "Ring" project.
-
 Later
 -----
 

diff --git a/ring/models.py b/ring/models.py
@@ -86,8 +86,10 @@ def crawl(self):
 
             if e.has_key('content'):
                 content = e.content[0].value
-            else:
+            elif e.has_key('summary'):
                 content = e.summary
+            else:
+                content = ""
 
             if e.has_key('published_parsed'):
                 published = time.mktime(e.published_parsed)

diff --git a/ring/templates/layout.html b/ring/templates/layout.html
@@ -77,8 +77,17 @@
 </div>
 
 <div id="footer-message">
-  The theme for this site is higly derived from <a href="http://drupal.org/project/arthemia">Drupal Arthemia</a>,
+  <p>Powered by <a href="https://github.com/sfermigier/Planet-GTLL">Ring</a>,
+    an open source project by <a href="http://fermigier.com">Stefane Fermigier</a>.
+    Depends on the <a href="http://flask.pocoo.org/">Flask</a> micro-framework,
+    on <a href="http://www.sqlalchemy.org/">SQLAlchemy</a>,
+    on <a href="http://www.sqlite.org/">SQLite3</a> 
+    and on <a href="http://feedparser.org/">Feedparser</a>.
+  </p>
+
+  <p>The theme for this site is highly derived from <a href="http://drupal.org/project/arthemia">Drupal Arthemia</a>,
   which itself is based on the original design by <a href="http://michaelhutagalung.com/">Michael Hutagalung</a>.
+  </p>
 </div>
 
 </body>

diff --git a/setup.py b/setup.py
@@ -9,7 +9,7 @@ def params():
     name = 'Ring'
     version = VERSION
     description = "Ring - a better planet"
-    long_description = open("README.txt").read()
+    long_description = open("README.md").read()
     # Get more strings from http://www.python.org/pypi?%3Aaction=list_classifiers
     classifiers = [
             "Framework :: Flask",