Updated readme to be more friendly.
This commit is contained in:
parent
12e2cf3187
commit
3b840015ed
14
README.md
14
README.md
@ -7,11 +7,14 @@ This script requires you have espeak-ng installed and in your path.
|
||||
|
||||
## Usage
|
||||
Place autospeak.pl in .irssi/scripts/
|
||||
|
||||
Then in irssi do:
|
||||
/script load autospeak
|
||||
|
||||
/script load autospeak
|
||||
|
||||
If you want to autorun the script, place the script in or simlink to ~/.irssi/scripts/autorun/
|
||||
|
||||
## Automated Install
|
||||
### Automated Install
|
||||
There is a basic install script, just run:
|
||||
|
||||
./install
|
||||
@ -29,10 +32,13 @@ This script has some settings. Use the /set command to set them.
|
||||
- speak_dcc_messages <on/off> - Speaks DCC messages; Notifys if a file transfer or dcc chat request.
|
||||
|
||||
### Explanation of Public Message Speaking
|
||||
This script is designed not to be very spammy. Public messages only speak when you are directly addressed, unless you have the speak_indirect_message setting on, then it speaks also when you are mensioned.
|
||||
This script is designed not to be very spammy. Public messages only speak when you are directly addressed, unless you have the speak_indirect_message setting on, then it speaks no matter where in the message are you mensioned.
|
||||
|
||||
#### Examples
|
||||
When only speak_public_messages is on,
|
||||
|
||||
"<someone> jticket: Hi there!" Will be spoken.
|
||||
|
||||
"<someone> Hi there jticket!" will not automatically be spoken.
|
||||
When speak_public_messages and speak_indirect_messages is on, both will be spoken.
|
||||
|
||||
When speak_public_messages and speak_indirect_messages is on, both will be spoken.
|
||||
|
Loading…
Reference in New Issue
Block a user