Skip to content

Commit

Permalink
Fixing README
Browse files Browse the repository at this point in the history
  • Loading branch information
jtatum committed Nov 6, 2010
1 parent 774f157 commit 6b51795
Showing 1 changed file with 18 additions and 15 deletions.
33 changes: 18 additions & 15 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,32 @@
A text-to-speech plugin for the Colloquy IRC client
-----------------------------------------------------

:author: James Tatum, <jtatum@gmail.com>

Installation
============
Drop speech.py into one of these locations:
~/Library/Application Support/Colloquy/PlugIns (current user)
/Library/Application Support/Colloquy/PlugIns (all users)
/Network/Library/Application Support/Colloquy/PlugIns (all users on the network)
Drop speech.py into one of these locations::

~/Library/Application Support/Colloquy/PlugIns (current user)
/Library/Application Support/Colloquy/PlugIns (all users)
/Network/Library/Application Support/Colloquy/PlugIns (all users on the network)

If Colloquy is running, reload the plugin with /reload plugins

Usage
=====
/speech on
That's pretty much all you have to do. The computer will begin speaking every
line of text in channel.
/speech on
Enable speech. That's pretty much all you have to do to use this plugin.
The computer will begin speaking every line of text in channel.

/speech off
Disable the plugin
/speech off
Disable the plugin

/speech voices
Display a list of available voices
/speech voices
Display a list of available voices

/speech voice <voice>
Select a speaking voice
/speech voice
Select a speaking voice, for instance /speech voice Agnes

/speech help
Produce a list of all commands available in the speech plugin.
/speech help
Produce a list of all commands available in the speech plugin.

0 comments on commit 6b51795

Please sign in to comment.