Made readme a markdown file for github, and added python-oauth as a dep

This commit is contained in:
Anna 2010-05-20 11:57:55 -04:00
parent 8e6be490c6
commit 5a4b118e04

View File

@ -8,12 +8,12 @@ mytwitter is a simple python twitter application. I wrote it for two reasons:
While I doubt it will be terribly useful for anyone other than me, feel free to take it for a spin and let me know how it goes. While I doubt it will be terribly useful for anyone other than me, feel free to take it for a spin and let me know how it goes.
INSTALLATION ### Installation
------------
You'll need the following python modules: You'll need the following python modules:
* pyGTK * pyGTK
* dateutil * dateutil
* python-oauth
* twitter (the dev version, not 0.6), along with my patches (included here) * twitter (the dev version, not 0.6), along with my patches (included here)
@ -29,13 +29,10 @@ python setup.py install --user
This will install python-twitter in your ~/.local/lib directory, which python 2.6 will automatically include in PYTHONPATH. This will install python-twitter in your ~/.local/lib directory, which python 2.6 will automatically include in PYTHONPATH.
### Configuration
CONFIGURATION
-------------
Copy the supplied mytwitter.conf file to ~/.mytwitter.conf, and edit it to suit your preferences. At a minimum, you need to change the [account] section to contain a valid twitter username and password. You can have multiple [account] sections, but they must be uniquely named, and the section name must start with 'account'. Copy the supplied mytwitter.conf file to ~/.mytwitter.conf, and edit it to suit your preferences. At a minimum, you need to change the [account] section to contain a valid twitter username and password. You can have multiple [account] sections, but they must be uniquely named, and the section name must start with 'account'.
### Usage
USAGE
-----
Just run ./mytwitter.py, and start playing around. Right now, it is best to run this file in-place; it expects twitterwidgets.py and default.glade to be in the same directory. Just run ./mytwitter.py, and start playing around. Right now, it is best to run this file in-place; it expects twitterwidgets.py and default.glade to be in the same directory.