diff --git a/ascii.py b/ascii.py index 2323186..5139995 100644 --- a/ascii.py +++ b/ascii.py @@ -1,3 +1,12 @@ +""" +Print something in ASCII text. +Running from the console will print the text to the console. +Running in a chat or room window will send the ASCII text + +Requires 'figlet' which is available on most linux distros e.g.: + sudo apt-get install figlet +""" + import prof import subprocess diff --git a/browser.py b/browser.py index f2c8eed..886e088 100644 --- a/browser.py +++ b/browser.py @@ -1,3 +1,7 @@ +""" +Open the last link received in a chat or room window using the systems default browser +""" + import prof import os import webbrowser diff --git a/emoticons.py b/emoticons.py index 5bd1a4f..6a9ffc9 100644 --- a/emoticons.py +++ b/emoticons.py @@ -1,3 +1,7 @@ +""" +Convert smileys ( :) :( etc) to the Unicode character representation +""" + import prof def _emote(input_str): diff --git a/paste.py b/paste.py index 8e433fb..42ede25 100644 --- a/paste.py +++ b/paste.py @@ -1,3 +1,7 @@ +""" +Paste the contents of the clipboard when in a chat or room window. +""" + import prof import sys import Tkinter as tk diff --git a/say.py b/say.py index 3500ba2..508415d 100644 --- a/say.py +++ b/say.py @@ -1,3 +1,12 @@ +""" +Read message out loud. + +On linux requires 'espeak' which is available on most distributions e.g.: + sudo apt-get install espeak + +On OSX will use the built in 'say' command. +""" + import prof import os from sys import platform