Changeset 33

Show
Ignore:
Timestamp:
01/02/07 22:41:50 (5 years ago)
Author:
tim
Message:

More informative, better organized README.txt

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • trunk/README.txt

    r30 r33  
    11CogPlanet 
    2  
    3 This is a TurboGears (http://www.turbogears.org) project. It can be 
    4 started by running the start-cogplanet.py script.  Before doing so, a 
    5 value should be set for sqlalchemy.dburi in your configuration file. 
     2========= 
    63 
    74CogPlanet is a planet server.  It aggregates content from multiple 
    85syndication feeds and displays the feeds in chronological order on its 
    96homepage. 
     7 
     8More information regarding the project can be found at: 
     9http://achievewith.us/projects/cogplanet 
     10 
     11Please submit bugs and/or patches at the URL above.  This project is 
     12still very new, so there are many bugs and patches to submit. 
     13 
     14Installation 
     15------------ 
     16 
     17This is a TurboGears (http://www.turbogears.org) project. It can be 
     18started by running the start-cogplanet.py script.  Before doing so, 
     19follow these steps: 
     20 
     210. Install dependencies: 
     22   # easy_install BeautifulSoup Genshi SQLAlchemy "TurboGears==1.0b2" 
     23   - download and install [http://feedparser.org/ Universal Feed Parser] 
     241. Set a value for sqlalchemy.dburi in your configuration file 
     25   (dev.cfg by default) 
     262. Run tg-admin sql create 
    1027 
    1128During your first time running start-cogplanet.py, you will be asked a 
    … …  
    1532configuration file. 
    1633 
    17 Information regarding the project can be found at: 
    18 http://achievewith.us/projects/cogplanet 
     34Your help in documenting deployment via egg files is appreciated.  To 
     35the best of our knowledge there is no way to run the 'tg-admin sql 
     36create' command without having the project directory available. 
    1937 
    20 Please submit bugs and/or patches at the URL above.  This project is 
    21 still very new, so there are many bugs and patches to submit. 
    22  
    23 Author contact information: 
     38Contacts 
     39-------- 
    2440 
    2541Tim Freund:  email: ["tim *at* achievewith *dot* us", 
    … …  
    2844             gtalk: timfreund *at* gmail *dot* com  
    2945             aim:   tpfreund 
     46 
     47Links 
     48----- 
     49[http://www.planetplanet.org/ Planet] 
     50[http://turbogears.org TurboGears] 
     51[http://feedparser.org/ Universal Feed Parser]