diff --git a/README b/README.markdown similarity index 78% rename from README rename to README.markdown index b5ea322..6722830 100644 --- a/README +++ b/README.markdown @@ -8,34 +8,31 @@ 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. -INSTALLATION ------------- +### Installation You'll need the following python modules: * pyGTK * dateutil +* python-oauth * twitter (the dev version, not 0.6), along with my patches (included here) For the twitter module, you can download and install it with: -hg clone https://python-twitter.googlecode.com/hg/ python-twitter -cd python-twitter -hg update dev -for i in ../mytwitter/python-twitter-*.patch; do patch p1 < $i; done -python setup.py build -python setup.py install --user + hg clone https://python-twitter.googlecode.com/hg/ python-twitter + cd python-twitter + hg update dev + for i in ../mytwitter/python-twitter-*.patch; do patch p1 < $i; done + python setup.py build + python setup.py install --user 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'. - -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.