Updated documentation

This commit is contained in:
Anna
2010-04-21 13:58:15 -04:00
parent ec22042a31
commit d58a1c6f6e
2 changed files with 19 additions and 2 deletions

19
README
View File

@ -5,7 +5,12 @@ mytwitter is a simple python twitter application. I wrote it for two reasons:
2. An excuse to learn Python
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. You'll need the following python modules:
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
------------
You'll need the following python modules:
* pyGTK
* dateutil
@ -22,3 +27,15 @@ 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
-------------
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.
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.