From 3b840015ed771c64e21fd8c8d73d4131c1098ccc Mon Sep 17 00:00:00 2001 From: Jeremiah Ticket Date: Thu, 5 Oct 2023 11:38:39 -0600 Subject: [PATCH] Updated readme to be more friendly. --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ef8c044..3c14ab8 100644 --- a/README.md +++ b/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 - 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, + " jticket: Hi there!" Will be spoken. + " Hi there jticket!" will not automatically be spoken. -When speak_public_messages and speak_indirect_messages is on, both will be spoken. \ No newline at end of file + +When speak_public_messages and speak_indirect_messages is on, both will be spoken.